docs: update JSDoc examples to use console.error instead of throwing errors

Planeshifter · Planeshifter · commit cb4ee9260bfd · 2025-12-26T19:28:26.000-06:00
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
diff --git a/lib/node_modules/@stdlib/_tools/browserify/file-list/lib/index.js b/lib/node_modules/@stdlib/_tools/browserify/file-list/lib/index.js
@@ -33,7 +33,7 @@
 *
 * function clbk( error ) {
 *     if ( error ) {
-*         throw error;
+*         console.error( error.message );
 *     }
 * }
 *
@@ -46,7 +46,7 @@
 *
 * function clbk( error, bundle ) {
 *     if ( error ) {
-*         throw error;
+*         return console.error( error.message );
 *     }
 *     console.log( bundle.toString() );
 * }
diff --git a/lib/node_modules/@stdlib/_tools/browserify/file-list/lib/main.js b/lib/node_modules/@stdlib/_tools/browserify/file-list/lib/main.js
@@ -53,7 +53,7 @@ var debug = logger( 'browserify:file-list' );
 *
 * function clbk( error, bundle ) {
 *     if ( error ) {
-*         throw error;
+*         return console.error( error.message );
 *     }
 *     console.log( bundle.toString() );
 * }
diff --git a/lib/node_modules/@stdlib/_tools/licenses/insert-header-file-list/lib/index.js b/lib/node_modules/@stdlib/_tools/licenses/insert-header-file-list/lib/index.js
@@ -36,7 +36,7 @@
 *
 * function done( error ) {
 *     if ( error ) {
-*         throw error;
+*         console.error( error.message );
 *     }
 * }
 *
@@ -51,7 +51,7 @@
 *
 * var err = insertHeader.sync( files, header );
 * if ( err instanceof Error ) {
-*     throw err;
+*     console.error( err.message );
 * }
 */
 
diff --git a/lib/node_modules/@stdlib/_tools/licenses/insert-header-file-list/lib/sync.js b/lib/node_modules/@stdlib/_tools/licenses/insert-header-file-list/lib/sync.js
@@ -67,7 +67,7 @@ var FOPTS = {
 *
 * var err = insertHeader( files, header );
 * if ( err instanceof Error ) {
-*     throw err;
+*     console.error( err.message );
 * }
 */
 function insertHeader( files, header ) {
diff --git a/lib/node_modules/@stdlib/_tools/licenses/remove-header-file-list/lib/index.js b/lib/node_modules/@stdlib/_tools/licenses/remove-header-file-list/lib/index.js
@@ -36,7 +36,7 @@
 *
 * function done( error ) {
 *     if ( error ) {
-*         throw error;
+*         console.error( error.message );
 *     }
 * }
 *
@@ -51,7 +51,7 @@
 *
 * var err = removeHeader.sync( files, header );
 * if ( err instanceof Error ) {
-*     throw err;
+*     console.error( err.message );
 * }
 */
 
diff --git a/lib/node_modules/@stdlib/_tools/licenses/remove-header-file-list/lib/sync.js b/lib/node_modules/@stdlib/_tools/licenses/remove-header-file-list/lib/sync.js
@@ -68,7 +68,7 @@ var FOPTS = {
 *
 * var err = removeHeader( files, header );
 * if ( err instanceof Error ) {
-*     throw err;
+*     console.error( err.message );
 * }
 */
 function removeHeader( files, header ) {
diff --git a/lib/node_modules/@stdlib/_tools/licenses/update-header-file-list/lib/index.js b/lib/node_modules/@stdlib/_tools/licenses/update-header-file-list/lib/index.js
@@ -38,7 +38,7 @@
 *
 * function done( error ) {
 *     if ( error ) {
-*         throw error;
+*         console.error( error.message );
 *     }
 * }
 *
@@ -55,7 +55,7 @@
 *
 * var err = updateHeader.sync( files, old, header );
 * if ( err instanceof Error ) {
-*     throw err;
+*     console.error( err.message );
 * }
 */
 
diff --git a/lib/node_modules/@stdlib/_tools/licenses/update-header-file-list/lib/sync.js b/lib/node_modules/@stdlib/_tools/licenses/update-header-file-list/lib/sync.js
@@ -72,7 +72,7 @@ var FOPTS = {
 *
 * var err = updateHeader( files, old, header );
 * if ( err instanceof Error ) {
-*     throw err;
+*     console.error( err.message );
 * }
 */
 function updateHeader( files, old, header ) {
@@ -97,7 +97,7 @@ function updateHeader( files, old, header ) {
 		for ( i = 0; i < keys.length; i++ ) {
 			v = old[ keys[i] ];
 			if ( !isString( v ) && !isRegExp( v ) ) {
-				throw new TypeError( format( 'invalid argument. A header object must map each filename extension to a license header string or regular expression. `%s: %s`. Value: `%s`.',  keys[i], v, JSON.stringify( old ) ) );
+				throw new TypeError( format( 'invalid argument. A header object must map each filename extension to a license header string or regular expression. `%s: %s`. Value: `%s`.', keys[i], v, JSON.stringify( old ) ) );
 			}
 		}
 	} else if ( !isString( old ) && !isRegExp( old ) ) {
diff --git a/lib/node_modules/@stdlib/_tools/lint/license-header-file-list/lib/index.js b/lib/node_modules/@stdlib/_tools/lint/license-header-file-list/lib/index.js
@@ -36,7 +36,7 @@
 *
 * function onLint( error, errs ) {
 *     if ( error ) {
-*         throw error;
+*         return console.error( error.message );
 *     }
 *     console.error( errs );
 * }
@@ -52,9 +52,10 @@
 *
 * var errs = lint.sync( files, header );
 * if ( errs instanceof Error ) {
-*     throw errs;
+*     console.error( errs.message );
+* } else {
+*     console.error( errs );
 * }
-* console.error( errs );
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/_tools/lint/license-header-file-list/lib/main.js b/lib/node_modules/@stdlib/_tools/lint/license-header-file-list/lib/main.js
@@ -77,7 +77,7 @@ var SPDX = 'Apache-2.0';
 *
 * function onLint( error, errs ) {
 *     if ( error ) {
-*         throw error;
+*         return console.error( error.message );
 *     }
 *     console.error( errs );
 * }
diff --git a/lib/node_modules/@stdlib/_tools/lint/license-header-file-list/lib/sync.js b/lib/node_modules/@stdlib/_tools/lint/license-header-file-list/lib/sync.js
@@ -71,9 +71,10 @@ var SPDX = 'Apache-2.0';
 *
 * var errs = lint( files, header );
 * if ( errs instanceof Error ) {
-*     throw errs;
+*     console.error( errs.message );
+* } else {
+*     console.error( errs );
 * }
-* console.error( errs );
 */
 function lint( files, header ) {
 	var total;

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@`
`33`	`33`	`*`
`34`	`34`	`* function clbk( error ) {`
`35`	`35`	`* if ( error ) {`
`36`		`-* throw error;`
	`36`	`+* console.error( error.message );`
`37`	`37`	`* }`
`38`	`38`	`* }`
`39`	`39`	`*`
`@@ -46,7 +46,7 @@`
`46`	`46`	`*`
`47`	`47`	`* function clbk( error, bundle ) {`
`48`	`48`	`* if ( error ) {`
`49`		`-* throw error;`
	`49`	`+* return console.error( error.message );`
`50`	`50`	`* }`
`51`	`51`	`* console.log( bundle.toString() );`
`52`	`52`	`* }`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ var debug = logger( 'browserify:file-list' );`
`53`	`53`	`*`
`54`	`54`	`* function clbk( error, bundle ) {`
`55`	`55`	`* if ( error ) {`
`56`		`-* throw error;`
	`56`	`+* return console.error( error.message );`
`57`	`57`	`* }`
`58`	`58`	`* console.log( bundle.toString() );`
`59`	`59`	`* }`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@`
`36`	`36`	`*`
`37`	`37`	`* function done( error ) {`
`38`	`38`	`* if ( error ) {`
`39`		`-* throw error;`
	`39`	`+* console.error( error.message );`
`40`	`40`	`* }`
`41`	`41`	`* }`
`42`	`42`	`*`
`@@ -51,7 +51,7 @@`
`51`	`51`	`*`
`52`	`52`	`* var err = insertHeader.sync( files, header );`
`53`	`53`	`* if ( err instanceof Error ) {`
`54`		`-* throw err;`
	`54`	`+* console.error( err.message );`
`55`	`55`	`* }`
`56`	`56`	`*/`
`57`	`57`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ var FOPTS = {`
`67`	`67`	`*`
`68`	`68`	`* var err = insertHeader( files, header );`
`69`	`69`	`* if ( err instanceof Error ) {`
`70`		`-* throw err;`
	`70`	`+* console.error( err.message );`
`71`	`71`	`* }`
`72`	`72`	`*/`
`73`	`73`	`function insertHeader( files, header ) {`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ var FOPTS = {`
`68`	`68`	`*`
`69`	`69`	`* var err = removeHeader( files, header );`
`70`	`70`	`* if ( err instanceof Error ) {`
`71`		`-* throw err;`
	`71`	`+* console.error( err.message );`
`72`	`72`	`* }`
`73`	`73`	`*/`
`74`	`74`	`function removeHeader( files, header ) {`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@`
`38`	`38`	`*`
`39`	`39`	`* function done( error ) {`
`40`	`40`	`* if ( error ) {`
`41`		`-* throw error;`
	`41`	`+* console.error( error.message );`
`42`	`42`	`* }`
`43`	`43`	`* }`
`44`	`44`	`*`
`@@ -55,7 +55,7 @@`
`55`	`55`	`*`
`56`	`56`	`* var err = updateHeader.sync( files, old, header );`
`57`	`57`	`* if ( err instanceof Error ) {`
`58`		`-* throw err;`
	`58`	`+* console.error( err.message );`
`59`	`59`	`* }`
`60`	`60`	`*/`
`61`	`61`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ var FOPTS = {`
`72`	`72`	`*`
`73`	`73`	`* var err = updateHeader( files, old, header );`
`74`	`74`	`* if ( err instanceof Error ) {`
`75`		`-* throw err;`
	`75`	`+* console.error( err.message );`
`76`	`76`	`* }`
`77`	`77`	`*/`
`78`	`78`	`function updateHeader( files, old, header ) {`
`@@ -97,7 +97,7 @@ function updateHeader( files, old, header ) {`
`97`	`97`	`for ( i = 0; i < keys.length; i++ ) {`
`98`	`98`	`v = old[ keys[i] ];`
`99`	`99`	`if ( !isString( v ) && !isRegExp( v ) ) {`
`100`		- throw new TypeError( format( 'invalid argument. A header object must map each filename extension to a license header string or regular expression. `%s: %s`. Value: `%s`.', keys[i], v, JSON.stringify( old ) ) );
	`100`	+ throw new TypeError( format( 'invalid argument. A header object must map each filename extension to a license header string or regular expression. `%s: %s`. Value: `%s`.', keys[i], v, JSON.stringify( old ) ) );
`101`	`101`	`}`
`102`	`102`	`}`
`103`	`103`	`} else if ( !isString( old ) && !isRegExp( old ) ) {`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ var SPDX = 'Apache-2.0';`
`77`	`77`	`*`
`78`	`78`	`* function onLint( error, errs ) {`
`79`	`79`	`* if ( error ) {`
`80`		`-* throw error;`
	`80`	`+* return console.error( error.message );`
`81`	`81`	`* }`
`82`	`82`	`* console.error( errs );`
`83`	`83`	`* }`