Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 68 Commits
.github		.github
benchmark		benchmark
bin		bin
dist		dist
docs		docs
etc		etc
examples		examples
lib		lib
test		test
.editorconfig		.editorconfig
.eslintrc.js		.eslintrc.js
.gitattributes		.gitattributes
.gitignore		.gitignore
.npmignore		.npmignore
.npmrc		.npmrc
CHANGELOG.md		CHANGELOG.md
CITATION.cff		CITATION.cff
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
CONTRIBUTORS		CONTRIBUTORS
LICENSE		LICENSE
Makefile		Makefile
NOTICE		NOTICE
README.md		README.md
SECURITY.md		SECURITY.md
branches.md		branches.md
package.json		package.json

Repository files navigation

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please considerfinancially supporting stdlib. We greatly appreciate your continued support!

isNodeBuiltin

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

Installation

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

Alternatively,

To load the package in a website via ascript tag without installation and bundlers, use theES Module available on theesm branch (seeREADME).
If you are using Deno, visit thedeno branch (seeREADME for usage intructions).
For use in Observable, or in browser/node environments, use theUniversal Module Definition (UMD) build available on theumd branch (seeREADME).
To use as a general utility for the command line, install the correspondingCLI package globally.

Thebranches.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.

Usage

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

isNodeBuiltin( value )

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

varbool=isNodeBuiltin('util');// returns true

Notes

For non-string values, the function returnsfalse.

Examples

varisNodeBuiltin=require('@stdlib/assert-is-node-builtin');varout=isNodeBuiltin('fs');// returns trueout=isNodeBuiltin('child_process');// returns trueout=isNodeBuiltin('fs-extra');// returns falseout=isNodeBuiltin('moment');// returns false

CLI

Installation

To use as a general utility, install the CLI package globally

npm install -g @stdlib/assert-is-node-builtin-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 aregular expression, ensure that thesplit 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 cryptotrue

To use as astandard stream,

$echo -n'crypto\ncluster\nfs-extra'| is-node-builtintruetruefalse

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

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

Notice

This package is part ofstdlib, 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 developstdlib, see the main projectrepository.