vm.runInContext

History

vm.runInContext(code, contextifiedObject, options?): void

Attributes

code:string

The JavaScript code to compile and run.

contextifiedObject:Object

The contextified object that will be used as the global when the code is compiled and run.

options:Object | string

filename?:string

Specifies the filename used in stack traces produced by this script. Default: 'evalmachine.<anonymous>'.

lineOffset?:number

Specifies the line number offset that is displayed in stack traces produced by this script. Default: 0.

columnOffset?:number

Specifies the first-line column number offset that is displayed in stack traces produced by this script. Default: 0.

displayErrors?:boolean

When true, if an Error occurs while compiling the code, the line of code causing the error is attached to the stack trace. Default: true.

timeout:integer

Specifies the number of milliseconds to execute code before terminating execution. If execution is terminated, an Error will be thrown. This value must be a strictly positive integer.

breakOnSigint?:boolean

If true, receiving SIGINT (Ctrl+C) will terminate execution and throw an Error. Existing handlers for the event that have been attached via process.on('SIGINT') are disabled during script execution, but continue to work after that. Default: false.

cachedData:Buffer | TypedArray | DataView

Provides an optional Buffer or TypedArray, or DataView with V8's code cache data for the supplied source.

importModuleDynamically:Function | vm.constants.USE_MAIN_CONTEXT_DEFAULT_LOADER

Used to specify the how the modules should be loaded during the evaluation of this script when import() is called. This option is part of the experimental modules API. We do not recommend using it in a production environment. For detailed information, see Support of dynamic import() in compilation APIs.

The vm.runInContext() method compiles code, runs it within the context of the contextifiedObject, then returns the result. Running code does not have access to the local scope. The contextifiedObject object must have been previously contextified using the vm.createContext() method.

If options is a string, then it specifies the filename.

The following example compiles and executes different scripts using a single contextified object:

import { createContext, runInContext } from 'node:vm';

const contextObject = { globalVar: 1 };
createContext(contextObject);

for (let i = 0; i < 10; ++i) {
  runInContext('globalVar *= 2;', contextObject);
}
console.log(contextObject);
// Prints: { globalVar: 1024 }

JavaScript

const { createContext, runInContext } = require('node:vm');

const contextObject = { globalVar: 1 };
createContext(contextObject);

for (let i = 0; i < 10; ++i) {
  runInContext('globalVar *= 2;', contextObject);
}
console.log(contextObject);
// Prints: { globalVar: 1024 }

JavaScript