@stdlib/assert-is-node-builtin

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

Usage no npm install needed!

<script type="module">
  import stdlibAssertIsNodeBuiltin from 'https://cdn.skypack.dev/@stdlib/assert-is-node-builtin';
</script>

README

isNodeBuiltin

NPM version Build Status Coverage Status

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

Installation

npm install @stdlib/assert-is-node-builtin

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

Installation

To use the module as a general utility, install the module globally

npm install -g @stdlib/assert-is-node-builtin

Usage

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

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ is-node-builtin crypto
true

To use as a standard stream,

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

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.