Объект Module

• <Объект>

Предоставляет общие служебные методы при работе с экземплярами Module, переменной module, часто встречающейся в модулях CommonJS. Доступ к нему осуществляется через import 'module' или require('module').

module.builtinModules

• <строка[]>

Список имён всех модулей, предоставляемых Node.js. Может использоваться для проверки, поддерживается ли модуль третьей стороной или нет.

module в этом контексте — не тот же объект, что и предоставляемый обёрткой модуля. Для доступа к нему требуется импортировать модуль Module:

Модули MJS

// module.mjs
// In an ECMAScript module
import { builtinModules as builtin } from 'module';

Модули CJS

// module.cjs
// In a CommonJS module
const builtin = require('module').builtinModules;

module.createRequire(filename)

• filename <строка> | <URL> Имя файла, используемое для построения функции require. Должно быть объектом URL файла, строкой URL файла или строкой абсолютного пути.
• Возвращает: <require> Функция require

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

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

module.syncBuiltinESMExports()

Метод module.syncBuiltinESMExports() обновляет все активные связи для встроенных модулей ES Модулей, чтобы они соответствовали свойствам экспорта CommonJS. Он не добавляет и не удаляет экспортируемые имена из модулей ES Модулей.

const fs = require('fs');
const assert = require('assert');
const { syncBuiltinESMExports } = require('module');

fs.readFile = newAPI;

delete fs.readFileSync;

function newAPI() {
  // ...
}

fs.newAPI = newAPI;

syncBuiltinESMExports();

import('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.

Модули MJS

// module.mjs
// In an ECMAScript module
import { findSourceMap, SourceMap } from 'module';

Модули CJS

// module.cjs
// In a CommonJS module
const { findSourceMap, SourceMap } = require('module');

module.findSourceMap(path)

• path <строка>
• Возвращает: <module.SourceMap>

path — это разрешённый путь к файлу, для которого требуется получить соответствующую карту исходного кода.

Класс: module.SourceMap

new SourceMap(payload)

• payload <Объект>

Создаёт новый экземпляр sourceMap.

payload — это объект с ключами, соответствующими формату карты исходного кода v3:

• file: <строка>
• version: <число>
• sources: <строка[]>
• sourcesContent: <строка[]>
• names: <строка[]>
• mappings: <строка>
• sourceRoot: <строка>

sourceMap.payload

• Возвращает: <Объект>

Получение полезной нагрузки, используемой для создания экземпляра SourceMap.

sourceMap.findEntry(lineNumber, columnNumber)

• lineNumber <число>
• columnNumber <число>
• Возвращает: <Объект>

Принимая номер строки и номер столбца в сгенерированном файле, возвращает объект, представляющий позицию в исходном файле. Возвращаемый объект содержит следующие ключи:

• generatedLine: <число>
• generatedColumn: <число>
• originalSource: <строка>
• originalLine: <число>
• originalColumn: <число>
• name: <строка>