is-builtin

Universal drop-in replacement for module.isBuiltin

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • isBuiltin(m)
• Types
• Related
• Contribute

What is this?

This package is a universal drop-in replacement for module.isBuiltin.

When should I use this?

This package exports a single function that can be used to determine if a module is a builtin module. Builtin modules are core modules maintained by Node.js. They can be imported by name or using a node: URL.

Install

This package is ESM only.

In Node.js (version 18+) with yarn:

yarn add @flex-development/is-builtin

In Deno with esm.sh:

import { isBuiltin } from 'https://esm.sh/@flex-development/is-builtin'

In browsers with esm.sh:

<script type="module">
  import { isBuiltin } from 'https://esm.sh/@flex-development/is-builtin'
</script>

Use

import { isBuiltin } from '@flex-development/is-builtin'

isBuiltin('@flex-development/is-builtin') // false
isBuiltin('assert')                       // true
isBuiltin('fs/promises')                  // true
isBuiltin(new URL('node:os'))             // true
isBuiltin('node:module')                  // true
isBuiltin('node:test/reporters')          // true
isBuiltin('test')                         // false
isBuiltin(null)                           // false

API

This package exports the identifier isBuiltin.

The default export is also isBuiltin.

isBuiltin(m)

Check if m references a builtin module.

👉 Note: m will be converted to a string (String(m)) before being checked.

Parameters

• m (unknown) — the thing to check

Returns

true if m references builtin module, false otherwise.

Types

This package is fully typed with TypeScript.

Related

• builtin-modules — Universal drop-in replacement for module.builtinModules

Contribute

See CONTRIBUTING.md.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.