Node.js v18.16.0 文档

Module 对象#

• <Object>

在与 Module 的实例交互时提供通用实用方法，module 变量经常出现在 CommonJS 模块中。 通过 import 'node:module' 或 require('node:module') 访问。

module.builtinModules#

• <string[]>

Node.js 提供的所有模块的名称列表。 可用于验证模块是否由第三方维护。

此上下文中的 module 与 模块封装器 提供的对象不同。 要访问它，需要 Module 模块：

// module.mjs
// In an ECMAScript module
import { builtinModules as builtin } from 'node:module';// module.cjs
// In a CommonJS module
const builtin = require('node:module').builtinModules;拷贝

module.createRequire(filename)#

• filename <string> | <URL> 用于构造 require 函数的文件名。 必须是文件网址对象、文件网址字符串、或绝对路径字符串。
• 返回： <require> require 函数

import { createRequire } from 'node:module';
const require = createRequire(import.meta.url);

// sibling-module.js is a CommonJS module.
const siblingModule = require('./sibling-module'); 拷贝

module.isBuiltin(moduleName)#

• moduleName <string> 模块名称
• 返回： <boolean> 如果模块是内置的，则返回 true，否则返回 false

import { isBuiltin } from 'node:module';
isBuiltin('node:fs'); // true
isBuiltin('fs'); // true
isBuiltin('wss'); // false 拷贝

module.syncBuiltinESMExports()#

module.syncBuiltinESMExports() 方法更新内置 ES 模块 的所有实时绑定以匹配 CommonJS 导出的属性。 它不会在 ES 模块 中添加或删除导出的名称。

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) => {
  // It syncs the existing readFile property with the new value
  assert.strictEqual(esmFS.readFile, newAPI);
  // readFileSync has been deleted from the required fs
  assert.strictEqual('readFileSync' in fs, false);
  // syncBuiltinESMExports() does not remove readFileSync from esmFS
  assert.strictEqual('readFileSync' in esmFS, true);
  // syncBuiltinESMExports() does not add names
  assert.strictEqual(esmFS.newAPI, undefined);
}); 拷贝

源映射 v3 支持#

与源映射缓存交互的助手。 当启用源映射解析并且在模块的页脚中找到 源映射包含指令 时，将填充此缓存。

要启用源映射解析，则 Node.js 必须使用标志 --enable-source-maps 运行、或者通过设置 NODE_V8_COVERAGE=dir 启用代码覆盖率。

// module.mjs
// In an ECMAScript module
import { findSourceMap, SourceMap } from 'node:module';// module.cjs
// In a CommonJS module
const { findSourceMap, SourceMap } = require('node:module');拷贝

module.findSourceMap(path)#

• path <string>
• 返回： <module.SourceMap> | <undefined> 如果找到源映射，则返回 module.SourceMap，否则返回 undefined。

path 是文件的解析路径，应为其获取相应的源映射。

类：module.SourceMap#

new SourceMap(payload)#

• payload <Object>

创建新的 sourceMap 实例。

payload 是一个对象，其键与 源地图 v3 格式 匹配：

• file: <string>
• version: <number>
• sources: <string[]>
• sourcesContent: <string[]>
• names: <string[]>
• mappings: <string>
• sourceRoot: <string>

sourceMap.payload#

• 返回： <Object>

用于构造 SourceMap 实例的有效负载的获取器。

sourceMap.findEntry(lineNumber, columnNumber)#

• lineNumber <number>
• columnNumber <number>
• 返回： <Object>

给定生成的源文件中的行号和列号，返回表示原始文件中位置的对象。 返回的对象包含以下键：

• generatedLine: <number>
• generatedColumn: <number>
• originalSource: <string>
• originalLine: <number>
• originalColumn: <number>
• name: <string>