is-builtin-module
Version:
Check if a string matches the name of a Node.js builtin module
26 lines (18 loc) • 702 B
TypeScript
/**
Check if a string matches the name of a Node.js builtin module.
This matches based a [static list of modules](https://github.com/sindresorhus/builtin-modules) from the latest Node.js version. If you want to check for a module in the current Node.js, use the core [`isBuiltin`](https://nodejs.org/api/module.html#moduleisbuiltinmodulename) method.
@param moduleName - The name of the module.
@example
```
import isBuiltinModule from 'is-builtin-module';
isBuiltinModule('fs');
//=> true
isBuiltinModule('fs/promises');
//=> true
isBuiltinModule('node:fs/promises');
//=> true
isBuiltinModule('unicorn');
//=> false
```
*/
export default function isBuiltinModule(moduleName: string): boolean;