Wrap `require` in a try/catch block.
APACHE-2.0 License
Wrap
require
in a try/catch block.
npm install @stdlib/utils-try-require
Alternatively,
script
tag without installation and bundlers, use the ES Module available on the esm
branch (see README).deno
branch (see README for usage intructions).umd
branch (see README).The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
var tryRequire = require( '@stdlib/utils-try-require' );
Wraps require
in a try/catch
block. If able to resolve a module id
, the function returns the value bound to module.exports
in the resolved module. Otherwise, the function returns an Error
.
var x = tryRequire( 'beep' );
if ( x instanceof Error ) {
console.log( x.message );
}
Use caution when attempting to resolve a relative path or a local module. This function attempts to resolve a module from its current path. Thus, the function is unable to resolve anything which is not along its search path. For local requires, use an absolute file path.
var resolve = require( 'path' ).resolve;
var out = tryRequire( resolve( '/foo/bar/baz', '..', 'lib', 'beep.js' ) );
if ( out instanceof Error ) {
console.error( out.message );
}
var tryRequire = require( '@stdlib/utils-try-require' );
var out = tryRequire( '_abcdefghijklmnopqrstuvwxyz123456789_' );
if ( out instanceof Error ) {
console.error( out.message );
} else {
throw new Error( 'expected an error' );
}
out = tryRequire( '@stdlib/utils-try-require' );
if ( out !== tryRequire ) {
throw new Error( 'expected export' );
}
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.