function

vm.runInContext

function runInContext(
code: string,
contextifiedObject: Context,
options?: string | RunningCodeOptions
): any;

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 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 }
@param code

The JavaScript code to compile and run.

@param contextifiedObject

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

@returns

the result of the very last statement executed in the script.

Referenced types

interface Context

interface RunningCodeOptions

  • breakOnSigint?: boolean

    If true, the execution will be terminated when SIGINT (Ctrl+C) is received. Existing handlers for the event that have been attached via process.on('SIGINT') will be disabled during script execution, but will continue to work after that. If execution is terminated, an Error will be thrown.

  • cachedData?: ArrayBufferView<ArrayBufferLike>

    Provides an optional data with V8's code cache data for the supplied source.

  • columnOffset?: number

    Specifies the column number offset that is displayed in stack traces produced by this script.

  • 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.

  • filename?: string

    Specifies the filename used in stack traces produced by this script.

  • importModuleDynamically?: number | DynamicModuleLoader<Script>

    Used to specify 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.

  • lineOffset?: number

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

  • timeout?: number

    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.