stdlib/lib/node_modules/@stdlib/assert/is-node-builtin at develop

isNodeBuiltin

Test whether a string matches a Node.js built-in module name.

Usage

var isNodeBuiltin = require( '@stdlib/assert/is-node-builtin' );

isNodeBuiltin( value )

Tests whether a string matches a Node.js built-in module name.

var bool = isNodeBuiltin( 'util' );
// returns true

Notes

For non-string values, the function returns false.

Examples

var isNodeBuiltin = require( '@stdlib/assert/is-node-builtin' );

var out = isNodeBuiltin( 'fs' );
// returns true

out = isNodeBuiltin( 'child_process' );
// returns true

out = isNodeBuiltin( 'fs-extra' );
// returns false

out = isNodeBuiltin( 'moment' );
// returns false

CLI

Usage

Usage: is-node-builtin [options] [<string>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
         --split sep           Delimiter for stdin data. Default: '/\\r?\\n/'.

Notes

If the split separator is a regular expression, ensure that the split option is either properly escaped or enclosed in quotes.

# Not escaped...
$ echo -n $'crypto\nndarray' | is-node-builtin --split /\r?\n/
# Escaped...
$ echo -n $'crypto\nndarray' | is-node-builtin --split /\\r?\\n/

The implementation ignores trailing delimiters.

Examples

$ is-node-builtin crypto
true

To use as a standard stream,

$ echo -n 'crypto\ncluster\nfs-extra' | is-node-builtin
true
true
false

By default, when used as a standard stream, the implementation assumes newline-delimited data. To specify an alternative delimiter, set the split option.

$ echo -n 'crypto\tbaz' | is-node-builtin --split '\t'
true
false