vm

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

Соответствует полю [[RequestedModules]] записи циклического модуля в спецификации ECMAScript.

Если module.status имеет значение 'errored', это свойство содержит исключение, вызванное модулем во время вычисления. При любом другом статусе обращение к этому свойству приведёт к вызову исключения.

Значение undefined нельзя использовать в случаях, когда исключение не было вызвано, поскольку его можно спутать со значением throw undefined;.

Соответствует полю [[EvaluationError]] записи циклического модуля в спецификации ECMAScript.

Идентификатор текущего модуля, заданный в конструкторе.

Объект пространства имён модуля. Доступен только после завершения связывания (module.link()).

Соответствует абстрактной операции GetModuleNamespace в спецификации ECMAScript.

Текущий статус модуля. Может принимать одно из следующих значений:

• 'unlinked': вызов module.link() ещё не выполнялся.
• 'linking': вызов module.link() выполнен, но ещё не все промисы, возвращённые функцией связывания, разрешены.
• 'linked': модуль успешно связан, и все его зависимости связаны, но вызов module.evaluate() ещё не выполнялся.
• 'evaluating': выполняется вычисление модуля посредством module.evaluate() для него самого или родительского модуля.
• 'evaluated': модуль успешно вычислен.
• 'errored': модуль вычислен, но при этом было вызвано исключение.

За исключением 'errored', эта строка статуса соответствует полю [[Status]] записи Cyclic Module Record в спецификации. 'errored' соответствует значению 'evaluated' в спецификации, но при этом [[EvaluationError]] задано значением, отличным от undefined.

Вычисляет модуль.

Этот метод необходимо вызвать после связывания модуля; в противном случае промис будет отклонён. Его также можно вызвать, если модуль уже был вычислен. В этом случае метод либо ничего не сделает, если первоначальное вычисление завершилось успешно (module.status имеет значение 'evaluated'), либо повторно вызовет исключение, возникшее в результате первоначального вычисления (module.status имеет значение 'errored').

Этот метод нельзя вызывать во время вычисления модуля (module.status имеет значение 'evaluating').

Соответствует полю конкретного метода Evaluate() записи Cyclic Module Record в спецификации ECMAScript.

Связывает зависимости модуля. Этот метод необходимо вызвать до вычисления; для каждого модуля его можно вызвать только один раз.

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

• Он должен принадлежать тому же контексту, что и родительский Module.
• Его status не должно иметь значение 'errored'.

Если status у возвращённого объекта Module имеет значение 'unlinked', этот метод будет рекурсивно вызван для возвращённого объекта Module с той же предоставленной функцией linker.

link() возвращает объект Promise, который будет разрешён, когда все экземпляры связывания разрешатся в допустимый Module, или отклонён, если функция связывания вызовет исключение либо вернёт недопустимый Module.

Функция связывания приблизительно соответствует определяемой реализацией абстрактной операции HostResolveImportedModule в спецификации ECMAScript, но имеет несколько важных отличий:

• Функция связывания может быть асинхронной, тогда как HostResolveImportedModule является синхронной.

Фактическая реализация HostResolveImportedModule, используемая при связывании модулей, возвращает модули, связанные в ходе связывания. Поскольку к этому моменту все модули уже полностью связаны, реализация HostResolveImportedModule полностью синхронна в соответствии со спецификацией.

Соответствует полю конкретного метода Link() записи Cyclic Module Record в спецификации ECMAScript.

Если при создании vm.Script передан cachedData, это значение будет установлено в true или false в зависимости от того, приняты ли данные V8. В противном случае значение равно undefined.

Если сценарий скомпилирован из исходного текста, содержащего специальный комментарий с source map, этому свойству будет присвоен URL карты исходного кода.

import vm from 'node:vm';

const script = new vm.Script(`
function myFunc() {}
//# sourceMappingURL=sourcemap.json
`);

console.log(script.sourceMapURL);
// Prints: sourcemap.json

Создаёт кэш кода, который можно использовать с параметром cachedData конструктора Script. Возвращает объект Buffer. Этот метод можно вызывать в любое время и любое количество раз.

Кэш кода Script не содержит состояний, наблюдаемых из JavaScript. Кэш кода безопасно хранить вместе с исходным текстом сценария и использовать для многократного создания новых экземпляров Script.

Функции в исходном тексте Script можно пометить для отложенной компиляции; в таком случае они не компилируются при создании Script. Эти функции будут скомпилированы при первом вызове. Кэш кода сериализует метаданные, известные V8 на данный момент о Script, которые можно использовать для ускорения будущих компиляций.

const script = new vm.Script(`
function add(a, b) {
  return a + b;
}

const x = add(1, 2);
`);

const cacheWithoutAdd = script.createCachedData();
// In `cacheWithoutAdd` the function `add()` is marked for full compilation
// upon invocation.

script.runInThisContext();

const cacheWithAdd = script.createCachedData();
// `cacheWithAdd` contains fully compiled function `add()`.

Запускает скомпилированный код, содержащийся в объекте vm.Script, в заданном contextifiedObject и возвращает результат. Выполняемый код не имеет доступа к локальной области видимости.

В следующем примере компилируется код, который увеличивает глобальную переменную и задаёт значение другой глобальной переменной, после чего код выполняется несколько раз. Глобальные переменные находятся в объекте context.

import vm from 'node:vm';

const context = {
  animal: 'cat',
  count: 2,
};

const script = new vm.Script('count += 1; name = "kitty";');

vm.createContext(context);
for (let i = 0; i < 10; ++i) {
  script.runInContext(context);
}

console.log(context);
// Prints: { animal: 'cat', count: 12, name: 'kitty' }

Использование параметров timeout или breakOnSigint приведёт к созданию новых циклов событий и соответствующих потоков, что повлечёт ненулевые дополнительные затраты производительности.

Этот метод является сокращённой формой вызова script.runInContext(vm.createContext(options), options). Он выполняет сразу несколько действий:

1. Создаёт новый контекст.
2. Если contextObject — объект, он контекстуализируется в новом контексте. Если contextObject не определён, создаётся новый объект и контекстуализируется. Если contextObject имеет значение vm.constants.DONT_CONTEXTIFY, контекстуализация не выполняется.
3. Запускает скомпилированный код, содержащийся в объекте vm.Script, в созданном контексте. Код не имеет доступа к области видимости, в которой вызван этот метод.
4. Возвращает результат.

В следующем примере компилируется код, который задаёт глобальную переменную, после чего выполняет этот код несколько раз в разных контекстах. Глобальные переменные задаются в каждом отдельном объекте context и хранятся в нём.

const vm = require('node:vm');

const script = new vm.Script('globalVar = "set"');

const contexts = [{}, {}, {}];
contexts.forEach((context) => {
  script.runInNewContext(context);
});

console.log(contexts);
// Prints: [{ globalVar: 'set' }, { globalVar: 'set' }, { globalVar: 'set' }]

// This would throw if the context is created from a contextified object.
// vm.constants.DONT_CONTEXTIFY allows creating contexts with ordinary
// global objects that can be frozen.
const freezeScript = new vm.Script('Object.freeze(globalThis); globalThis;');
const frozenContext = freezeScript.runInNewContext(vm.constants.DONT_CONTEXTIFY);

Запускает скомпилированный код, содержащийся в vm.Script, в контексте текущего объекта global. Выполняемый код не имеет доступа к локальной области видимости, но имеет доступ к текущему объекту global.

В следующем примере компилируется код, увеличивающий переменную global, после чего этот код выполняется несколько раз:

import vm from 'node:vm';

global.globalVar = 0;

const script = new vm.Script('globalVar += 1', { filename: 'myfile.vm' });

for (let i = 0; i < 1000; ++i) {
  script.runInThisContext();
}

console.log(globalVar);

// 1000

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

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

Этот метод используется после связывания модуля для задания значений экспортируемых элементов. Если вызвать его до связывания модуля, будет вызвана ошибка ERR_VM_MODULE_STATUS.

import vm from 'node:vm';

const m = new vm.SyntheticModule(['x'], () => {
  m.setExport('x', 1);
});

await m.link(() => {});
await m.evaluate();

assert.strictEqual(m.namespace.x, 1);

Задает имя файла, используемое в трассировках стека, формируемых этим скриптом.

Задает смещение номера строки, отображаемое в трассировках стека, формируемых этим скриптом.

Задает смещение номера столбца, отображаемое в трассировках стека, формируемых этим скриптом.

Предоставляет необязательные данные кэша кода V8 для указанного исходного кода.

Указывает, следует ли создавать новые данные кэша.

Песочница/контекст, в котором должна быть скомпилирована указанная функция.

Массив, содержащий набор расширений контекста (объектов, оборачивающих текущую область видимости), которые применяются при компиляции

Понятное человеку имя вновь созданного контекста.

Указывает источник вновь созданного контекста для отображения. Источник должен быть отформатирован как URL, но содержать только схему, хост и порт (если он необходим), как значение свойства url.origin объекта URL. В частности, эта строка не должна содержать завершающую косую черту, поскольку она обозначает путь.

Если задано значение afterEvaluate, микрозадачи будут выполнены сразу после завершения скрипта.

Понятное человеку имя вновь созданного контекста.

Источник, соответствующий вновь созданному контексту и предназначенный для отображения. Источник должен быть отформатирован как URL, но содержать только схему, хост и порт (если необходимо), как значение свойства url.origin объекта URL. В частности, эта строка не должна содержать завершающую косую черту, поскольку она обозначает путь.

Если задано значение afterEvaluate, микрозадачи будут выполнены сразу после выполнения скрипта.

Если значение true, то при возникновении Error во время компиляции code строка кода, вызвавшая ошибку, добавляется в трассировку стека.

Задает количество миллисекунд, в течение которых должен выполняться код до прекращения выполнения. Если выполнение прекращено, будет выброшено исключение Error. Это значение должно быть строго положительным целым числом.

Если значение true, выполнение будет прекращено при получении SIGINT (Ctrl+C). Существующие обработчики этого события, добавленные через process.on('SIGINT'), будут отключены на время выполнения скрипта, но продолжат работать после его завершения. Если выполнение прекращено, будет выброшено исключение Error.

Данные кэша кода V8 для предоставленного исходного кода.

Используется для указания способа загрузки модулей при вычислении этого скрипта, когда вызывается import(). Эта опция является частью экспериментального API модулей. Не рекомендуется использовать ее в рабочей среде. Подробную информацию см. в разделе Поддержка динамического import() в API компиляции.

Строка, используемая в трассировках стека.

Вызывается при вычислении этого модуля для инициализации import.meta.

Строка, используемая в трассировках стека.

Контекстизированный объект, возвращаемый методом vm.createContext(), в котором компилируется и вычисляется этот модуль.