@stdlib/utils-try-require
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    tryRequire

    NPM version Build Status Coverage Status

    Wrap require in a try/catch block.

    Installation

    npm install @stdlib/utils-try-require

    Usage

    var tryRequire = require( '@stdlib/utils-try-require' );

    tryRequire( id )

    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 );
    }

    Notes

    • 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 );
      }

    Examples

    var tryRequire = require( '@stdlib/utils-try-require' );
    
    var out;
    
    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' );
    }

    Notice

    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.

    Community

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/utils-try-require

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    8,900

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    37.3 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser