Modules: node:module
API#
Added in: v0.3.7
The Module
object#
Provides general utility methods when interacting with instances of
Module
, the module
variable often seen in CommonJS modules. Accessed
via import 'node:module'
or require('node:module')
.
module.builtinModules
#
Added in: v9.3.0, v8.10.0, v6.13.0
A list of the names of all modules provided by Node.js. Can be used to verify
if a module is maintained by a third party or not.
module
in this context isn't the same object that's provided
by the module wrapper. To access it, require the Module
module:
import { builtinModules as builtin } from 'node:module';
const builtin = require('node:module').builtinModules;
module.createRequire(filename)
#
Added in: v12.2.0
filename
<string> | <URL> Filename to be used to construct the require
function. Must be a file URL object, file URL string, or absolute path
string.
- Returns: <require> Require function
import { createRequire } from 'node:module';
const require = createRequire(import.meta.url);
const siblingModule = require('./sibling-module');
module.isBuiltin(moduleName)
#
Added in: v16.17.0
moduleName
<string> name of the module
- Returns: <boolean> returns true if the module is builtin else returns false
import { isBuiltin } from 'node:module';
isBuiltin('node:fs');
isBuiltin('fs');
isBuiltin('wss');
module.syncBuiltinESMExports()
#
Added in: v12.12.0
The module.syncBuiltinESMExports()
method updates all the live bindings for
builtin ES Modules to match the properties of the CommonJS exports. It
does not add or remove exported names from the ES Modules.
const fs = require('node:fs');
const assert = require('node:assert');
const { syncBuiltinESMExports } = require('node:module');
fs.readFile = newAPI;
delete fs.readFileSync;
function newAPI() {
}
fs.newAPI = newAPI;
syncBuiltinESMExports();
import('node:fs').then((esmFS) => {
assert.strictEqual(esmFS.readFile, newAPI);
assert.strictEqual('readFileSync' in fs, false);
assert.strictEqual('readFileSync' in esmFS, true);
assert.strictEqual(esmFS.newAPI, undefined);
});
Source map v3 support#
Added in: v13.7.0, v12.17.0
Helpers for interacting with the source map cache. This cache is
populated when source map parsing is enabled and
source map include directives are found in a modules' footer.
To enable source map parsing, Node.js must be run with the flag
--enable-source-maps
, or with code coverage enabled by setting
NODE_V8_COVERAGE=dir
.
import { findSourceMap, SourceMap } from 'node:module';
const { findSourceMap, SourceMap } = require('node:module');
module.findSourceMap(path)
#
Added in: v13.7.0, v12.17.0
path
is the resolved path for the file for which a corresponding source map
should be fetched.
Class: module.SourceMap
#
Added in: v13.7.0, v12.17.0
new SourceMap(payload)
#
Creates a new sourceMap
instance.
payload
is an object with keys matching the Source map v3 format:
sourceMap.payload
#
Getter for the payload used to construct the SourceMap
instance.
sourceMap.findEntry(lineNumber, columnNumber)
#
Given a line number and column number in the generated source file, returns
an object representing the position in the original file. The object returned
consists of the following keys: