22

✏️ Editing: vm.json

{
 "type": "module",
 "source": "doc/api/vm.md",
 "modules": [
 {
 "textRaw": "VM (executing JavaScript)",
 "name": "vm",
 "introduced_in": "v0.10.0",
 "stability": 2,
 "stabilityText": "Stable",
 "desc": "Source Code: <a href=\"https://github.com/nodejs/node/blob/v12.22.12/lib/vm.js\">lib/vm.js</a>\nThe <code>vm</code> module enables compiling and running code within V8 Virtual\nMachine contexts. The <code>vm</code> module is not a security mechanism. Do\nnot use it to run untrusted code.\nJavaScript code can be compiled and run immediately or\ncompiled, saved, and run later.\nA common use case is to run the code in a different V8 Context. This means\ninvoked code has a different global object than the invoking code.\nOne can provide the context by <a href=\"#vm_what_does_it_mean_to_contextify_an_object\">contextifying</a> an\nobject. The invoked code treats any property in the context like a\nglobal variable. Any changes to global variables caused by the invoked\ncode are reflected in the context object.\n<pre><code class=\"language-js\">const vm = require('vm');\n\nconst x = 1;\n\nconst context = { x: 2 };\nvm.createContext(context); // Contextify the object.\n\nconst code = 'x += 40; var y = 17;';\n// `x` and `y` are global variables in the context.\n// Initially, x has the value 2 because that is the value of context.x.\nvm.runInContext(code, context);\n\nconsole.log(context.x); // 42\nconsole.log(context.y); // 17\n\nconsole.log(x); // 1; y is not defined.\n</code></pre>",
 "classes": [
 {
 "textRaw": "Class: `vm.Script`",
 "type": "class",
 "name": "vm.Script",
 "meta": {
 "added": [
 "v0.3.1"
 ],
 "changes": []
 },
 "desc": "Instances of the <code>vm.Script</code> class contain precompiled scripts that can be\nexecuted in specific contexts.",
 "methods": [
 {
 "textRaw": "`script.createCachedData()`",
 "type": "method",
 "name": "createCachedData",
 "meta": {
 "added": [
 "v10.6.0"
 ],
 "changes": []
 },
 "signatures": [
 {
 "return": {
 "textRaw": "Returns: {Buffer}",
 "name": "return",
 "type": "Buffer"
 },
 "params": []
 }
 ],
 "desc": "Creates a code cache that can be used with the Script constructor's\n<code>cachedData</code> option. Returns a Buffer. This method may be called at any\ntime and any number of times.\n<pre><code class=\"language-js\">const script = new vm.Script(`\nfunction add(a, b) {\n return a + b;\n}\n\nconst x = add(1, 2);\n`);\n\nconst cacheWithoutX = script.createCachedData();\n\nscript.runInThisContext();\n\nconst cacheWithX = script.createCachedData();\n</code></pre>"
 },
 {
 "textRaw": "`script.runInContext(contextifiedObject[, options])`",
 "type": "method",
 "name": "runInContext",
 "meta": {
 "added": [
 "v0.3.1"
 ],
 "changes": [
 {
 "version": "v6.3.0",
 "pr-url": "https://github.com/nodejs/node/pull/6635",
 "description": "The `breakOnSigint` option is supported now."
 }
 ]
 },
 "signatures": [
 {
 "return": {
 "textRaw": "Returns: {any} the result of the very last statement executed in the script.",
 "name": "return",
 "type": "any",
 "desc": "the result of the very last statement executed in the script."
 },
 "params": [
 {
 "textRaw": "`contextifiedObject` {Object} A [contextified][] object as returned by the `vm.createContext()` method.",
 "name": "contextifiedObject",
 "type": "Object",
 "desc": "A [contextified][] object as returned by the `vm.createContext()` method."
 },
 {
 "textRaw": "`options` {Object}",
 "name": "options",
 "type": "Object",
 "options": [
 {
 "textRaw": "`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`.",
 "name": "displayErrors",
 "type": "boolean",
 "default": "`true`",
 "desc": "When `true`, if an [`Error`][] occurs while compiling the `code`, the line of code causing the error is attached to the stack trace."
 },
 {
 "textRaw": "`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.",
 "name": "timeout",
 "type": "integer",
 "desc": "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."
 },
 {
 "textRaw": "`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. **Default:** `false`.",
 "name": "breakOnSigint",
 "type": "boolean",
 "default": "`false`",
 "desc": "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."
 }
 ]
 }
 ]
 }
 ],
 "desc": "Runs the compiled code contained by the <code>vm.Script</code> object within the given\n<code>contextifiedObject</code> and returns the result. Running code does not have access\nto local scope.\nThe following example compiles code that increments a global variable, sets\nthe value of another global variable, then execute the code multiple times.\nThe globals are contained in the <code>context</code> object.\n<pre><code class=\"language-js\">const vm = require('vm');\n\nconst context = {\n animal: 'cat',\n count: 2\n};\n\nconst script = new vm.Script('count += 1; name = \"kitty\";');\n\nvm.createContext(context);\nfor (let i = 0; i &#x3C; 10; ++i) {\n script.runInContext(context);\n}\n\nconsole.log(context);\n// Prints: { animal: 'cat', count: 12, name: 'kitty' }\n</code></pre>\nUsing the <code>timeout</code> or <code>breakOnSigint</code> options will result in new event loops\nand corresponding threads being started, which have a non-zero performance\noverhead."
 },
 {
 "textRaw": "`script.runInNewContext([contextObject[, options]])`",
 "type": "method",
 "name": "runInNewContext",
 "meta": {
 "added": [
 "v0.3.1"
 ],
 "changes": [
 {
 "version": "v10.0.0",
 "pr-url": "https://github.com/nodejs/node/pull/19016",
 "description": "The `contextCodeGeneration` option is supported now."
 },
 {
 "version": "v6.3.0",
 "pr-url": "https://github.com/nodejs/node/pull/6635",
 "description": "The `breakOnSigint` option is supported now."
 }
 ]
 },
 "signatures": [
 {
 "return": {
 "textRaw": "Returns: {any} the result of the very last statement executed in the script.",
 "name": "return",
 "type": "any",
 "desc": "the result of the very last statement executed in the script."
 },
 "params": [
 {
 "textRaw": "`contextObject` {Object} An object that will be [contextified][]. If `undefined`, a new object will be created.",
 "name": "contextObject",
 "type": "Object",
 "desc": "An object that will be [contextified][]. If `undefined`, a new object will be created."
 },
 {
 "textRaw": "`options` {Object}",
 "name": "options",
 "type": "Object",
 "options": [
 {
 "textRaw": "`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`.",
 "name": "displayErrors",
 "type": "boolean",
 "default": "`true`",
 "desc": "When `true`, if an [`Error`][] occurs while compiling the `code`, the line of code causing the error is attached to the stack trace."
 },
 {
 "textRaw": "`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.",
 "name": "timeout",
 "type": "integer",
 "desc": "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."
 },
 {
 "textRaw": "`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. **Default:** `false`.",
 "name": "breakOnSigint",
 "type": "boolean",
 "default": "`false`",
 "desc": "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."
 },
 {
 "textRaw": "`contextName` {string} Human-readable name of the newly created context. **Default:** `'VM Context i'`, where `i` is an ascending numerical index of the created context.",
 "name": "contextName",
 "type": "string",
 "default": "`'VM Context i'`, where `i` is an ascending numerical index of the created context",
 "desc": "Human-readable name of the newly created context."
 },
 {
 "textRaw": "`contextOrigin` {string} [Origin][origin] corresponding to the newly created context for display purposes. The origin should be formatted like a URL, but with only the scheme, host, and port (if necessary), like the value of the [`url.origin`][] property of a [`URL`][] object. Most notably, this string should omit the trailing slash, as that denotes a path. **Default:** `''`.",
 "name": "contextOrigin",
 "type": "string",
 "default": "`''`",
 "desc": "[Origin][origin] corresponding to the newly created context for display purposes. The origin should be formatted like a URL, but with only the scheme, host, and port (if necessary), like the value of the [`url.origin`][] property of a [`URL`][] object. Most notably, this string should omit the trailing slash, as that denotes a path."
 },
 {
 "textRaw": "`contextCodeGeneration` {Object}",
 "name": "contextCodeGeneration",
 "type": "Object",
 "options": [
 {
 "textRaw": "`strings` {boolean} If set to false any calls to `eval` or function constructors (`Function`, `GeneratorFunction`, etc) will throw an `EvalError`. **Default:** `true`.",
 "name": "strings",
 "type": "boolean",
 "default": "`true`",
 "desc": "If set to false any calls to `eval` or function constructors (`Function`, `GeneratorFunction`, etc) will throw an `EvalError`."
 },
 {
 "textRaw": "`wasm` {boolean} If set to false any attempt to compile a WebAssembly module will throw a `WebAssembly.CompileError`. **Default:** `true`.",
 "name": "wasm",
 "type": "boolean",
 "default": "`true`",
 "desc": "If set to false any attempt to compile a WebAssembly module will throw a `WebAssembly.CompileError`."
 }
 ]
 }
 ]
 }
 ]
 }
 ],
 "desc": "First contextifies the given <code>contextObject</code>, runs the compiled code contained\nby the <code>vm.Script</code> object within the created context, and returns the result.\nRunning code does not have access to local scope.\nThe following example compiles code that sets a global variable, then executes\nthe code multiple times in different contexts. The globals are set on and\ncontained within each individual <code>context</code>.\n<pre><code class=\"language-js\">const vm = require('vm');\n\nconst script = new vm.Script('globalVar = \"set\"');\n\nconst contexts = [{}, {}, {}];\ncontexts.forEach((context) => {\n script.runInNewContext(context);\n});\n\nconsole.log(contexts);\n// Prints: [{ globalVar: 'set' }, { globalVar: 'set' }, { globalVar: 'set' }]\n</code></pre>"
 },
 {
 "textRaw": "`script.runInThisContext([options])`",
 "type": "method",
 "name": "runInThisContext",
 "meta": {
 "added": [
 "v0.3.1"
 ],
 "changes": [
 {
 "version": "v6.3.0",
 "pr-url": "https://github.com/nodejs/node/pull/6635",
 "description": "The `breakOnSigint` option is supported now."
 }
 ]
 },
 "signatures": [
 {
 "return": {
 "textRaw": "Returns: {any} the result of the very last statement executed in the script.",
 "name": "return",
 "type": "any",
 "desc": "the result of the very last statement executed in the script."
 },
 "params": [
 {
 "textRaw": "`options` {Object}",
 "name": "options",
 "type": "Object",
 "options": [
 {
 "textRaw": "`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`.",
 "name": "displayErrors",
 "type": "boolean",
 "default": "`true`",
 "desc": "When `true`, if an [`Error`][] occurs while compiling the `code`, the line of code causing the error is attached to the stack trace."
 },
 {
 "textRaw": "`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.",
 "name": "timeout",
 "type": "integer",
 "desc": "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."
 },
 {
 "textRaw": "`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. **Default:** `false`.",
 "name": "breakOnSigint",
 "type": "boolean",
 "default": "`false`",
 "desc": "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."
 }
 ]
 }
 ]
 }
 ],
 "desc": "Runs the compiled code contained by the <code>vm.Script</code> within the context of the\ncurrent <code>global</code> object. Running code does not have access to local scope, but\ndoes have access to the current <code>global</code> object.\nThe following example compiles code that increments a <code>global</code> variable then\nexecutes that code multiple times:\n<pre><code class=\"language-js\">const vm = require('vm');\n\nglobal.globalVar = 0;\n\nconst script = new vm.Script('globalVar += 1', { filename: 'myfile.vm' });\n\nfor (let i = 0; i &#x3C; 1000; ++i) {\n script.runInThisContext();\n}\n\nconsole.log(globalVar);\n\n// 1000\n</code></pre>"
 }
 ],
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`code` {string} The JavaScript code to compile.",
 "name": "code",
 "type": "string",
 "desc": "The JavaScript code to compile."
 },
 {
 "textRaw": "`options` {Object|string}",
 "name": "options",
 "type": "Object|string",
 "options": [
 {
 "textRaw": "`filename` {string} Specifies the filename used in stack traces produced by this script. **Default:** `'evalmachine.<anonymous>'`.",
 "name": "filename",
 "type": "string",
 "default": "`'evalmachine.<anonymous>'`",
 "desc": "Specifies the filename used in stack traces produced by this script."
 },
 {
 "textRaw": "`lineOffset` {number} Specifies the line number offset that is displayed in stack traces produced by this script. **Default:** `0`.",
 "name": "lineOffset",
 "type": "number",
 "default": "`0`",
 "desc": "Specifies the line number offset that is displayed in stack traces produced by this script."
 },
 {
 "textRaw": "`columnOffset` {number} Specifies the column number offset that is displayed in stack traces produced by this script. **Default:** `0`.",
 "name": "columnOffset",
 "type": "number",
 "default": "`0`",
 "desc": "Specifies the column number offset that is displayed in stack traces produced by this script."
 },
 {
 "textRaw": "`cachedData` {Buffer|TypedArray|DataView} Provides an optional `Buffer` or `TypedArray`, or `DataView` with V8's code cache data for the supplied source. When supplied, the `cachedDataRejected` value will be set to either `true` or `false` depending on acceptance of the data by V8.",
 "name": "cachedData",
 "type": "Buffer|TypedArray|DataView",
 "desc": "Provides an optional `Buffer` or `TypedArray`, or `DataView` with V8's code cache data for the supplied source. When supplied, the `cachedDataRejected` value will be set to either `true` or `false` depending on acceptance of the data by V8."
 },
 {
 "textRaw": "`produceCachedData` {boolean} When `true` and no `cachedData` is present, V8 will attempt to produce code cache data for `code`. Upon success, a `Buffer` with V8's code cache data will be produced and stored in the `cachedData` property of the returned `vm.Script` instance. The `cachedDataProduced` value will be set to either `true` or `false` depending on whether code cache data is produced successfully. This option is **deprecated** in favor of `script.createCachedData()`. **Default:** `false`.",
 "name": "produceCachedData",
 "type": "boolean",
 "default": "`false`",
 "desc": "When `true` and no `cachedData` is present, V8 will attempt to produce code cache data for `code`. Upon success, a `Buffer` with V8's code cache data will be produced and stored in the `cachedData` property of the returned `vm.Script` instance. The `cachedDataProduced` value will be set to either `true` or `false` depending on whether code cache data is produced successfully. This option is **deprecated** in favor of `script.createCachedData()`."
 },
 {
 "textRaw": "`importModuleDynamically` {Function} Called during evaluation of this module when `import()` is called. If this option is not specified, calls to `import()` will reject with [`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`][]. This option is part of the experimental modules API, and should not be considered stable.",
 "name": "importModuleDynamically",
 "type": "Function",
 "desc": "Called during evaluation of this module when `import()` is called. If this option is not specified, calls to `import()` will reject with [`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`][]. This option is part of the experimental modules API, and should not be considered stable.",
 "options": [
 {
 "textRaw": "`specifier` {string} specifier passed to `import()`",
 "name": "specifier",
 "type": "string",
 "desc": "specifier passed to `import()`"
 },
 {
 "textRaw": "`module` {vm.Module}",
 "name": "module",
 "type": "vm.Module"
 },
 {
 "textRaw": "Returns: {Module Namespace Object|vm.Module} Returning a `vm.Module` is recommended in order to take advantage of error tracking, and to avoid issues with namespaces that contain `then` function exports.",
 "name": "return",
 "type": "Module Namespace Object|vm.Module",
 "desc": "Returning a `vm.Module` is recommended in order to take advantage of error tracking, and to avoid issues with namespaces that contain `then` function exports."
 }
 ]
 }
 ]
 }
 ],
 "desc": "If <code>options</code> is a string, then it specifies the filename.\nCreating a new <code>vm.Script</code> object compiles <code>code</code> but does not run it. The\ncompiled <code>vm.Script</code> can be run later multiple times. The <code>code</code> is not bound to\nany global object; rather, it is bound before each run, just for that run."
 }
 ]
 },
 {
 "textRaw": "Class: `vm.Module`",
 "type": "class",
 "name": "vm.Module",
 "meta": {
 "added": [
 "v12.16.0"
 ],
 "changes": []
 },
 "stability": 1,
 "stabilityText": "Experimental",
 "desc": "This feature is only available with the <code>--experimental-vm-modules</code> command\nflag enabled.\nThe <code>vm.Module</code> class provides a low-level interface for using\nECMAScript modules in VM contexts. It is the counterpart of the <code>vm.Script</code>\nclass that closely mirrors <a href=\"https://www.ecma-international.org/ecma-262/#sec-abstract-module-records\">Module Record</a>s as defined in the ECMAScript\nspecification.\nUnlike <code>vm.Script</code> however, every <code>vm.Module</code> object is bound to a context from\nits creation. Operations on <code>vm.Module</code> objects are intrinsically asynchronous,\nin contrast with the synchronous nature of <code>vm.Script</code> objects. The use of\n'async' functions can help with manipulating <code>vm.Module</code> objects.\nUsing a <code>vm.Module</code> object requires three distinct steps: creation/parsing,\nlinking, and evaluation. These three steps are illustrated in the following\nexample.\nThis implementation lies at a lower level than the <a href=\"esm.html#esm_modules_ecmascript_modules\">ECMAScript Module\nloader</a>. There is also no way to interact with the Loader yet, though\nsupport is planned.\n<pre><code class=\"language-js\">const vm = require('vm');\n\nconst contextifiedObject = vm.createContext({ secret: 42 });\n\n(async () => {\n // Step 1\n //\n // Create a Module by constructing a new `vm.SourceTextModule` object. This\n // parses the provided source text, throwing a `SyntaxError` if anything goes\n // wrong. By default, a Module is created in the top context. But here, we\n // specify `contextifiedObject` as the context this Module belongs to.\n //\n // Here, we attempt to obtain the default export from the module \"foo\", and\n // put it into local binding \"secret\".\n\n const bar = new vm.SourceTextModule(`\n import s from 'foo';\n s;\n `, { context: contextifiedObject });\n\n // Step 2\n //\n // \"Link\" the imported dependencies of this Module to it.\n //\n // The provided linking callback (the \"linker\") accepts two arguments: the\n // parent module (`bar` in this case) and the string that is the specifier of\n // the imported module. The callback is expected to return a Module that\n // corresponds to the provided specifier, with certain requirements documented\n // in `module.link()`.\n //\n // If linking has not started for the returned Module, the same linker\n // callback will be called on the returned Module.\n //\n // Even top-level Modules without dependencies must be explicitly linked. The\n // callback provided would never be called, however.\n //\n // The link() method returns a Promise that will be resolved when all the\n // Promises returned by the linker resolve.\n //\n // Note: This is a contrived example in that the linker function creates a new\n // \"foo\" module every time it is called. In a full-fledged module system, a\n // cache would probably be used to avoid duplicated modules.\n\n async function linker(specifier, referencingModule) {\n if (specifier === 'foo') {\n return new vm.SourceTextModule(`\n // The \"secret\" variable refers to the global variable we added to\n // \"contextifiedObject\" when creating the context.\n export default secret;\n `, { context: referencingModule.context });\n\n // Using `contextifiedObject` instead of `referencingModule.context`\n // here would work as well.\n }\n throw new Error(`Unable to resolve dependency: ${specifier}`);\n }\n await bar.link(linker);\n\n // Step 3\n //\n // Evaluate the Module. The evaluate() method returns a Promise with a single\n // property \"result\" that contains the result of the very last statement\n // executed in the Module. In the case of `bar`, it is `s;`, which refers to\n // the default export of the `foo` module, the `secret` we set in the\n // beginning to 42.\n\n const { result } = await bar.evaluate();\n\n console.log(result);\n // Prints 42.\n})();\n</code></pre>",
 "properties": [
 {
 "textRaw": "`dependencySpecifiers` {string[]}",
 "type": "string[]",
 "name": "dependencySpecifiers",
 "desc": "The specifiers of all dependencies of this module. The returned array is frozen\nto disallow any changes to it.\nCorresponds to the <code>[[RequestedModules]]</code> field of <a href=\"https://tc39.es/ecma262/#sec-cyclic-module-records\">Cyclic Module Record</a>s in\nthe ECMAScript specification."
 },
 {
 "textRaw": "`error` {any}",
 "type": "any",
 "name": "error",
 "desc": "If the <code>module.status</code> is <code>'errored'</code>, this property contains the exception\nthrown by the module during evaluation. If the status is anything else,\naccessing this property will result in a thrown exception.\nThe value <code>undefined</code> cannot be used for cases where there is not a thrown\nexception due to possible ambiguity with <code>throw undefined;</code>.\nCorresponds to the <code>[[EvaluationError]]</code> field of <a href=\"https://tc39.es/ecma262/#sec-cyclic-module-records\">Cyclic Module Record</a>s\nin the ECMAScript specification."
 },
 {
 "textRaw": "`namespace` {Object}",
 "type": "Object",
 "name": "namespace",
 "desc": "The namespace object of the module. This is only available after linking\n(<code>module.link()</code>) has completed.\nCorresponds to the <a href=\"https://tc39.es/ecma262/#sec-getmodulenamespace\">GetModuleNamespace</a> abstract operation in the ECMAScript\nspecification."
 },
 {
 "textRaw": "`status` {string}",
 "type": "string",
 "name": "status",
 "desc": "The current status of the module. Will be one of:\n<ul>\n<li>\n<code>'unlinked'</code>: <code>module.link()</code> has not yet been called.\n</li>\n<li>\n<code>'linking'</code>: <code>module.link()</code> has been called, but not all Promises returned\nby the linker function have been resolved yet.\n</li>\n<li>\n<code>'linked'</code>: The module has been linked successfully, and all of its\ndependencies are linked, but <code>module.evaluate()</code> has not yet been called.\n</li>\n<li>\n<code>'evaluating'</code>: The module is being evaluated through a <code>module.evaluate()</code> on\nitself or a parent module.\n</li>\n<li>\n<code>'evaluated'</code>: The module has been successfully evaluated.\n</li>\n<li>\n<code>'errored'</code>: The module has been evaluated, but an exception was thrown.\n</li>\n</ul>\nOther than <code>'errored'</code>, this status string corresponds to the specification's\n<a href=\"https://tc39.es/ecma262/#sec-cyclic-module-records\">Cyclic Module Record</a>'s <code>[[Status]]</code> field. <code>'errored'</code> corresponds to\n<code>'evaluated'</code> in the specification, but with <code>[[EvaluationError]]</code> set to a\nvalue that is not <code>undefined</code>."
 },
 {
 "textRaw": "`identifier` {string}",
 "type": "string",
 "name": "identifier",
 "desc": "The identifier of the current module, as set in the constructor."
 }
 ],
 "methods": [
 {
 "textRaw": "`module.evaluate([options])`",
 "type": "method",
 "name": "evaluate",
 "signatures": [
 {
 "return": {
 "textRaw": "Returns: {Promise}",
 "name": "return",
 "type": "Promise"
 },
 "params": [
 {
 "textRaw": "`options` {Object}",
 "name": "options",
 "type": "Object",
 "options": [
 {
 "textRaw": "`timeout` {integer} Specifies the number of milliseconds to evaluate before terminating execution. If execution is interrupted, an [`Error`][] will be thrown. This value must be a strictly positive integer.",
 "name": "timeout",
 "type": "integer",
 "desc": "Specifies the number of milliseconds to evaluate before terminating execution. If execution is interrupted, an [`Error`][] will be thrown. This value must be a strictly positive integer."
 },
 {
 "textRaw": "`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 interrupted, an [`Error`][] will be thrown. **Default:** `false`.",
 "name": "breakOnSigint",
 "type": "boolean",
 "default": "`false`",
 "desc": "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 interrupted, an [`Error`][] will be thrown."
 }
 ]
 }
 ]
 }
 ],
 "desc": "Evaluate the module.\nThis must be called after the module has been linked; otherwise it will\nthrow an error. It could be called also when the module has already been\nevaluated, in which case it will do one of the following two things:\n<ul>\n<li>return <code>undefined</code> if the initial evaluation ended in success (<code>module.status</code>\nis <code>'evaluated'</code>)</li>\n<li>rethrow the same exception the initial evaluation threw if the initial\nevaluation ended in an error (<code>module.status</code> is <code>'errored'</code>)</li>\n</ul>\nThis method cannot be called while the module is being evaluated\n(<code>module.status</code> is <code>'evaluating'</code>) to prevent infinite recursion.\nCorresponds to the <a href=\"https://tc39.es/ecma262/#sec-moduleevaluation\">Evaluate() concrete method</a> field of <a href=\"https://tc39.es/ecma262/#sec-cyclic-module-records\">Cyclic Module\nRecord</a>s in the ECMAScript specification."
 },
 {
 "textRaw": "`module.link(linker)`",
 "type": "method",
 "name": "link",
 "signatures": [
 {
 "return": {
 "textRaw": "Returns: {Promise}",
 "name": "return",
 "type": "Promise"
 },
 "params": [
 {
 "textRaw": "`linker` {Function}",
 "name": "linker",
 "type": "Function",
 "options": [
 {
 "textRaw": "`specifier` {string} The specifier of the requested module:```js import foo from 'foo'; // ^^^^^ the module specifier ```",
 "name": "specifier",
 "type": "string",
 "desc": "The specifier of the requested module:```js import foo from 'foo'; // ^^^^^ the module specifier ```"
 },
 {
 "textRaw": "`referencingModule` {vm.Module} The `Module` object `link()` is called on.",
 "name": "referencingModule",
 "type": "vm.Module",
 "desc": "The `Module` object `link()` is called on."
 },
 {
 "textRaw": "Returns: {vm.Module|Promise}",
 "name": "return",
 "type": "vm.Module|Promise"
 }
 ]
 }
 ]
 }
 ],
 "desc": "Link module dependencies. This method must be called before evaluation, and\ncan only be called once per module.\nThe function is expected to return a <code>Module</code> object or a <code>Promise</code> that\neventually resolves to a <code>Module</code> object. The returned <code>Module</code> must satisfy the\nfollowing two invariants:\n<ul>\n<li>It must belong to the same context as the parent <code>Module</code>.</li>\n<li>Its <code>status</code> must not be <code>'errored'</code>.</li>\n</ul>\nIf the returned <code>Module</code>'s <code>status</code> is <code>'unlinked'</code>, this method will be\nrecursively called on the returned <code>Module</code> with the same provided <code>linker</code>\nfunction.\n<code>link()</code> returns a <code>Promise</code> that will either get resolved when all linking\ninstances resolve to a valid <code>Module</code>, or rejected if the linker function either\nthrows an exception or returns an invalid <code>Module</code>.\nThe linker function roughly corresponds to the implementation-defined\n<a href=\"https://tc39.es/ecma262/#sec-hostresolveimportedmodule\">HostResolveImportedModule</a> abstract operation in the ECMAScript\nspecification, with a few key differences:\n<ul>\n<li>The linker function is allowed to be asynchronous while\n<a href=\"https://tc39.es/ecma262/#sec-hostresolveimportedmodule\">HostResolveImportedModule</a> is synchronous.</li>\n</ul>\nThe actual <a href=\"https://tc39.es/ecma262/#sec-hostresolveimportedmodule\">HostResolveImportedModule</a> implementation used during module\nlinking is one that returns the modules linked during linking. Since at\nthat point all modules would have been fully linked already, the\n<a href=\"https://tc39.es/ecma262/#sec-hostresolveimportedmodule\">HostResolveImportedModule</a> implementation is fully synchronous per\nspecification.\nCorresponds to the <a href=\"https://tc39.es/ecma262/#sec-moduledeclarationlinking\">Link() concrete method</a> field of <a href=\"https://tc39.es/ecma262/#sec-cyclic-module-records\">Cyclic Module\nRecord</a>s in the ECMAScript specification."
 }
 ]
 },
 {
 "textRaw": "Class: `vm.SourceTextModule`",
 "type": "class",
 "name": "vm.SourceTextModule",
 "meta": {
 "added": [
 "v9.6.0"
 ],
 "changes": []
 },
 "stability": 1,
 "stabilityText": "Experimental",
 "desc": "This feature is only available with the <code>--experimental-vm-modules</code> command\nflag enabled.\n<ul>\n<li>Extends: <a href=\"vm.html#vm_class_vm_module\" class=\"type\">&lt;vm.Module&gt;</a></li>\n</ul>\nThe <code>vm.SourceTextModule</code> class provides the <a href=\"https://tc39.es/ecma262/#sec-source-text-module-records\">Source Text Module Record</a> as\ndefined in the ECMAScript specification.",
 "methods": [
 {
 "textRaw": "`sourceTextModule.createCachedData()`",
 "type": "method",
 "name": "createCachedData",
 "meta": {
 "added": [
 "v12.17.0"
 ],
 "changes": []
 },
 "signatures": [
 {
 "return": {
 "textRaw": "Returns: {Buffer}",
 "name": "return",
 "type": "Buffer"
 },
 "params": []
 }
 ],
 "desc": "Creates a code cache that can be used with the SourceTextModule constructor's\n<code>cachedData</code> option. Returns a Buffer. This method may be called any number\nof times before the module has been evaluated.\n<pre><code class=\"language-js\">// Create an initial module\nconst module = new vm.SourceTextModule('const a = 1;');\n\n// Create cached data from this module\nconst cachedData = module.createCachedData();\n\n// Create a new module using the cached data. The code must be the same.\nconst module2 = new vm.SourceTextModule('const a = 1;', { cachedData });\n</code></pre>"
 }
 ],
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`code` {string} JavaScript Module code to parse",
 "name": "code",
 "type": "string",
 "desc": "JavaScript Module code to parse"
 },
 {
 "textRaw": "`options`",
 "name": "options",
 "options": [
 {
 "textRaw": "`identifier` {string} String used in stack traces. **Default:** `'vm:module(i)'` where `i` is a context-specific ascending index.",
 "name": "identifier",
 "type": "string",
 "default": "`'vm:module(i)'` where `i` is a context-specific ascending index",
 "desc": "String used in stack traces."
 },
 {
 "textRaw": "`cachedData` {Buffer|TypedArray|DataView} Provides an optional `Buffer` or `TypedArray`, or `DataView` with V8's code cache data for the supplied source. The `code` must be the same as the module from which this `cachedData` was created.",
 "name": "cachedData",
 "type": "Buffer|TypedArray|DataView",
 "desc": "Provides an optional `Buffer` or `TypedArray`, or `DataView` with V8's code cache data for the supplied source. The `code` must be the same as the module from which this `cachedData` was created."
 },
 {
 "textRaw": "`context` {Object} The [contextified][] object as returned by the `vm.createContext()` method, to compile and evaluate this `Module` in.",
 "name": "context",
 "type": "Object",
 "desc": "The [contextified][] object as returned by the `vm.createContext()` method, to compile and evaluate this `Module` in."
 },
 {
 "textRaw": "`lineOffset` {integer} Specifies the line number offset that is displayed in stack traces produced by this `Module`. **Default:** `0`.",
 "name": "lineOffset",
 "type": "integer",
 "default": "`0`",
 "desc": "Specifies the line number offset that is displayed in stack traces produced by this `Module`."
 },
 {
 "textRaw": "`columnOffset` {integer} Specifies the column number offset that is displayed in stack traces produced by this `Module`. **Default:** `0`.",
 "name": "columnOffset",
 "type": "integer",
 "default": "`0`",
 "desc": "Specifies the column number offset that is displayed in stack traces produced by this `Module`."
 },
 {
 "textRaw": "`initializeImportMeta` {Function} Called during evaluation of this `Module` to initialize the `import.meta`.",
 "name": "initializeImportMeta",
 "type": "Function",
 "desc": "Called during evaluation of this `Module` to initialize the `import.meta`.",
 "options": [
 {
 "textRaw": "`meta` {import.meta}",
 "name": "meta",
 "type": "import.meta"
 },
 {
 "textRaw": "`module` {vm.SourceTextModule}",
 "name": "module",
 "type": "vm.SourceTextModule"
 }
 ]
 },
 {
 "textRaw": "`importModuleDynamically` {Function} Called during evaluation of this module when `import()` is called. If this option is not specified, calls to `import()` will reject with [`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`][].",
 "name": "importModuleDynamically",
 "type": "Function",
 "desc": "Called during evaluation of this module when `import()` is called. If this option is not specified, calls to `import()` will reject with [`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`][].",
 "options": [
 {
 "textRaw": "`specifier` {string} specifier passed to `import()`",
 "name": "specifier",
 "type": "string",
 "desc": "specifier passed to `import()`"
 },
 {
 "textRaw": "`module` {vm.Module}",
 "name": "module",
 "type": "vm.Module"
 },
 {
 "textRaw": "Returns: {Module Namespace Object|vm.Module} Returning a `vm.Module` is recommended in order to take advantage of error tracking, and to avoid issues with namespaces that contain `then` function exports.",
 "name": "return",
 "type": "Module Namespace Object|vm.Module",
 "desc": "Returning a `vm.Module` is recommended in order to take advantage of error tracking, and to avoid issues with namespaces that contain `then` function exports."
 }
 ]
 }
 ]
 }
 ],
 "desc": "Creates a new <code>SourceTextModule</code> instance.\nProperties assigned to the <code>import.meta</code> object that are objects may\nallow the module to access information outside the specified <code>context</code>. Use\n<code>vm.runInContext()</code> to create objects in a specific context.\n<pre><code class=\"language-js\">const vm = require('vm');\n\nconst contextifiedObject = vm.createContext({ secret: 42 });\n\n(async () => {\n const module = new vm.SourceTextModule(\n 'Object.getPrototypeOf(import.meta.prop).secret = secret;',\n {\n initializeImportMeta(meta) {\n // Note: this object is created in the top context. As such,\n // Object.getPrototypeOf(import.meta.prop) points to the\n // Object.prototype in the top context rather than that in\n // the contextified object.\n meta.prop = {};\n }\n });\n // Since module has no dependencies, the linker function will never be called.\n await module.link(() => {});\n await module.evaluate();\n\n // Now, Object.prototype.secret will be equal to 42.\n //\n // To fix this problem, replace\n // meta.prop = {};\n // above with\n // meta.prop = vm.runInContext('{}', contextifiedObject);\n})();\n</code></pre>"
 }
 ]
 },
 {
 "textRaw": "Class: `vm.SyntheticModule`",
 "type": "class",
 "name": "vm.SyntheticModule",
 "meta": {
 "added": [
 "v12.16.0"
 ],
 "changes": []
 },
 "stability": 1,
 "stabilityText": "Experimental",
 "desc": "This feature is only available with the <code>--experimental-vm-modules</code> command\nflag enabled.\n<ul>\n<li>Extends: <a href=\"vm.html#vm_class_vm_module\" class=\"type\">&lt;vm.Module&gt;</a></li>\n</ul>\nThe <code>vm.SyntheticModule</code> class provides the <a href=\"https://heycam.github.io/webidl/#synthetic-module-records\">Synthetic Module Record</a> as\ndefined in the WebIDL specification. The purpose of synthetic modules is to\nprovide a generic interface for exposing non-JavaScript sources to ECMAScript\nmodule graphs.\n<pre><code class=\"language-js\">const vm = require('vm');\n\nconst source = '{ \"a\": 1 }';\nconst module = new vm.SyntheticModule(['default'], function() {\n const obj = JSON.parse(source);\n this.setExport('default', obj);\n});\n\n// Use `module` in linking...\n</code></pre>",
 "methods": [
 {
 "textRaw": "`syntheticModule.setExport(name, value)`",
 "type": "method",
 "name": "setExport",
 "meta": {
 "added": [
 "v12.16.0"
 ],
 "changes": []
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`name` {string} Name of the export to set.",
 "name": "name",
 "type": "string",
 "desc": "Name of the export to set."
 },
 {
 "textRaw": "`value` {any} The value to set the export to.",
 "name": "value",
 "type": "any",
 "desc": "The value to set the export to."
 }
 ]
 }
 ],
 "desc": "This method is used after the module is linked to set the values of exports. If\nit is called before the module is linked, an <a href=\"errors.html#ERR_VM_MODULE_STATUS\"><code>ERR_VM_MODULE_STATUS</code></a> error\nwill be thrown.\n<pre><code class=\"language-js\">const vm = require('vm');\n\n(async () => {\n const m = new vm.SyntheticModule(['x'], () => {\n m.setExport('x', 1);\n });\n\n await m.link(() => {});\n await m.evaluate();\n\n assert.strictEqual(m.namespace.x, 1);\n})();\n</code></pre>"
 }
 ],
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`exportNames` {string[]} Array of names that will be exported from the module.",
 "name": "exportNames",
 "type": "string[]",
 "desc": "Array of names that will be exported from the module."
 },
 {
 "textRaw": "`evaluateCallback` {Function} Called when the module is evaluated.",
 "name": "evaluateCallback",
 "type": "Function",
 "desc": "Called when the module is evaluated."
 },
 {
 "textRaw": "`options`",
 "name": "options",
 "options": [
 {
 "textRaw": "`identifier` {string} String used in stack traces. **Default:** `'vm:module(i)'` where `i` is a context-specific ascending index.",
 "name": "identifier",
 "type": "string",
 "default": "`'vm:module(i)'` where `i` is a context-specific ascending index",
 "desc": "String used in stack traces."
 },
 {
 "textRaw": "`context` {Object} The [contextified][] object as returned by the `vm.createContext()` method, to compile and evaluate this `Module` in.",
 "name": "context",
 "type": "Object",
 "desc": "The [contextified][] object as returned by the `vm.createContext()` method, to compile and evaluate this `Module` in."
 }
 ]
 }
 ],
 "desc": "Creates a new <code>SyntheticModule</code> instance.\nObjects assigned to the exports of this instance may allow importers of\nthe module to access information outside the specified <code>context</code>. Use\n<code>vm.runInContext()</code> to create objects in a specific context."
 }
 ]
 }
 ],
 "methods": [
 {
 "textRaw": "`vm.compileFunction(code[, params[, options]])`",
 "type": "method",
 "name": "compileFunction",
 "meta": {
 "added": [
 "v10.10.0"
 ],
 "changes": []
 },
 "signatures": [
 {
 "return": {
 "textRaw": "Returns: {Function}",
 "name": "return",
 "type": "Function"
 },
 "params": [
 {
 "textRaw": "`code` {string} The body of the function to compile.",
 "name": "code",
 "type": "string",
 "desc": "The body of the function to compile."
 },
 {
 "textRaw": "`params` {string[]} An array of strings containing all parameters for the function.",
 "name": "params",
 "type": "string[]",
 "desc": "An array of strings containing all parameters for the function."
 },
 {
 "textRaw": "`options` {Object}",
 "name": "options",
 "type": "Object",
 "options": [
 {
 "textRaw": "`filename` {string} Specifies the filename used in stack traces produced by this script. **Default:** `''`.",
 "name": "filename",
 "type": "string",
 "default": "`''`",
 "desc": "Specifies the filename used in stack traces produced by this script."
 },
 {
 "textRaw": "`lineOffset` {number} Specifies the line number offset that is displayed in stack traces produced by this script. **Default:** `0`.",
 "name": "lineOffset",
 "type": "number",
 "default": "`0`",
 "desc": "Specifies the line number offset that is displayed in stack traces produced by this script."
 },
 {
 "textRaw": "`columnOffset` {number} Specifies the column number offset that is displayed in stack traces produced by this script. **Default:** `0`.",
 "name": "columnOffset",
 "type": "number",
 "default": "`0`",
 "desc": "Specifies the column number offset that is displayed in stack traces produced by this script."
 },
 {
 "textRaw": "`cachedData` {Buffer|TypedArray|DataView} Provides an optional `Buffer` or `TypedArray`, or `DataView` with V8's code cache data for the supplied source.",
 "name": "cachedData",
 "type": "Buffer|TypedArray|DataView",
 "desc": "Provides an optional `Buffer` or `TypedArray`, or `DataView` with V8's code cache data for the supplied source."
 },
 {
 "textRaw": "`produceCachedData` {boolean} Specifies whether to produce new cache data. **Default:** `false`.",
 "name": "produceCachedData",
 "type": "boolean",
 "default": "`false`",
 "desc": "Specifies whether to produce new cache data."
 },
 {
 "textRaw": "`parsingContext` {Object} The [contextified][] object in which the said function should be compiled in.",
 "name": "parsingContext",
 "type": "Object",
 "desc": "The [contextified][] object in which the said function should be compiled in."
 },
 {
 "textRaw": "`contextExtensions` {Object[]} An array containing a collection of context extensions (objects wrapping the current scope) to be applied while compiling. **Default:** `[]`.",
 "name": "contextExtensions",
 "type": "Object[]",
 "default": "`[]`",
 "desc": "An array containing a collection of context extensions (objects wrapping the current scope) to be applied while compiling."
 }
 ]
 }
 ]
 }
 ],
 "desc": "Compiles the given code into the provided context (if no context is\nsupplied, the current context is used), and returns it wrapped inside a\nfunction with the given <code>params</code>."
 },
 {
 "textRaw": "`vm.createContext([contextObject[, options]])`",
 "type": "method",
 "name": "createContext",
 "meta": {
 "added": [
 "v0.3.1"
 ],
 "changes": [
 {
 "version": "v10.0.0",
 "pr-url": "https://github.com/nodejs/node/pull/19398",
 "description": "The first argument can no longer be a function."
 },
 {
 "version": "v10.0.0",
 "pr-url": "https://github.com/nodejs/node/pull/19016",
 "description": "The `codeGeneration` option is supported now."
 }
 ]
 },
 "signatures": [
 {
 "return": {
 "textRaw": "Returns: {Object} contextified object.",
 "name": "return",
 "type": "Object",
 "desc": "contextified object."
 },
 "params": [
 {
 "textRaw": "`contextObject` {Object}",
 "name": "contextObject",
 "type": "Object"
 },
 {
 "textRaw": "`options` {Object}",
 "name": "options",
 "type": "Object",
 "options": [
 {
 "textRaw": "`name` {string} Human-readable name of the newly created context. **Default:** `'VM Context i'`, where `i` is an ascending numerical index of the created context.",
 "name": "name",
 "type": "string",
 "default": "`'VM Context i'`, where `i` is an ascending numerical index of the created context",
 "desc": "Human-readable name of the newly created context."
 },
 {
 "textRaw": "`origin` {string} [Origin][origin] corresponding to the newly created context for display purposes. The origin should be formatted like a URL, but with only the scheme, host, and port (if necessary), like the value of the [`url.origin`][] property of a [`URL`][] object. Most notably, this string should omit the trailing slash, as that denotes a path. **Default:** `''`.",
 "name": "origin",
 "type": "string",
 "default": "`''`",
 "desc": "[Origin][origin] corresponding to the newly created context for display purposes. The origin should be formatted like a URL, but with only the scheme, host, and port (if necessary), like the value of the [`url.origin`][] property of a [`URL`][] object. Most notably, this string should omit the trailing slash, as that denotes a path."
 },
 {
 "textRaw": "`codeGeneration` {Object}",
 "name": "codeGeneration",
 "type": "Object",
 "options": [
 {
 "textRaw": "`strings` {boolean} If set to false any calls to `eval` or function constructors (`Function`, `GeneratorFunction`, etc) will throw an `EvalError`. **Default:** `true`.",
 "name": "strings",
 "type": "boolean",
 "default": "`true`",
 "desc": "If set to false any calls to `eval` or function constructors (`Function`, `GeneratorFunction`, etc) will throw an `EvalError`."
 },
 {
 "textRaw": "`wasm` {boolean} If set to false any attempt to compile a WebAssembly module will throw a `WebAssembly.CompileError`. **Default:** `true`.",
 "name": "wasm",
 "type": "boolean",
 "default": "`true`",
 "desc": "If set to false any attempt to compile a WebAssembly module will throw a `WebAssembly.CompileError`."
 }
 ]
 }
 ]
 }
 ]
 }
 ],
 "desc": "If given a <code>contextObject</code>, the <code>vm.createContext()</code> method will <a href=\"#vm_what_does_it_mean_to_contextify_an_object\">prepare\nthat object</a> so that it can be used in calls to\n<a href=\"#vm_vm_runincontext_code_contextifiedobject_options\"><code>vm.runInContext()</code></a> or <a href=\"#vm_script_runincontext_contextifiedobject_options\"><code>script.runInContext()</code></a>. Inside such scripts,\nthe <code>contextObject</code> will be the global object, retaining all of its existing\nproperties but also having the built-in objects and functions any standard\n<a href=\"https://es5.github.io/#x15.1\">global object</a> has. Outside of scripts run by the vm module, global variables\nwill remain unchanged.\n<pre><code class=\"language-js\">const vm = require('vm');\n\nglobal.globalVar = 3;\n\nconst context = { globalVar: 1 };\nvm.createContext(context);\n\nvm.runInContext('globalVar *= 2;', context);\n\nconsole.log(context);\n// Prints: { globalVar: 2 }\n\nconsole.log(global.globalVar);\n// Prints: 3\n</code></pre>\nIf <code>contextObject</code> is omitted (or passed explicitly as <code>undefined</code>), a new,\nempty <a href=\"#vm_what_does_it_mean_to_contextify_an_object\">contextified</a> object will be returned.\nThe <code>vm.createContext()</code> method is primarily useful for creating a single\ncontext that can be used to run multiple scripts. For instance, if emulating a\nweb browser, the method can be used to create a single context representing a\nwindow's global object, then run all <code>&#x3C;script></code> tags together within that\ncontext.\nThe provided <code>name</code> and <code>origin</code> of the context are made visible through the\nInspector API."
 },
 {
 "textRaw": "`vm.isContext(object)`",
 "type": "method",
 "name": "isContext",
 "meta": {
 "added": [
 "v0.11.7"
 ],
 "changes": []
 },
 "signatures": [
 {
 "return": {
 "textRaw": "Returns: {boolean}",
 "name": "return",
 "type": "boolean"
 },
 "params": [
 {
 "textRaw": "`object` {Object}",
 "name": "object",
 "type": "Object"
 }
 ]
 }
 ],
 "desc": "Returns <code>true</code> if the given <code>oject</code> object has been <a href=\"#vm_what_does_it_mean_to_contextify_an_object\">contextified</a> using\n<a href=\"#vm_vm_createcontext_contextobject_options\"><code>vm.createContext()</code></a>."
 },
 {
 "textRaw": "`vm.runInContext(code, contextifiedObject[, options])`",
 "type": "method",
 "name": "runInContext",
 "meta": {
 "added": [
 "v0.3.1"
 ],
 "changes": [
 {
 "version": "v6.3.0",
 "pr-url": "https://github.com/nodejs/node/pull/6635",
 "description": "The `breakOnSigint` option is supported now."
 }
 ]
 },
 "signatures": [
 {
 "return": {
 "textRaw": "Returns: {any} the result of the very last statement executed in the script.",
 "name": "return",
 "type": "any",
 "desc": "the result of the very last statement executed in the script."
 },
 "params": [
 {
 "textRaw": "`code` {string} The JavaScript code to compile and run.",
 "name": "code",
 "type": "string",
 "desc": "The JavaScript code to compile and run."
 },
 {
 "textRaw": "`contextifiedObject` {Object} The [contextified][] object that will be used as the `global` when the `code` is compiled and run.",
 "name": "contextifiedObject",
 "type": "Object",
 "desc": "The [contextified][] object that will be used as the `global` when the `code` is compiled and run."
 },
 {
 "textRaw": "`options` {Object|string}",
 "name": "options",
 "type": "Object|string",
 "options": [
 {
 "textRaw": "`filename` {string} Specifies the filename used in stack traces produced by this script. **Default:** `'evalmachine.<anonymous>'`.",
 "name": "filename",
 "type": "string",
 "default": "`'evalmachine.<anonymous>'`",
 "desc": "Specifies the filename used in stack traces produced by this script."
 },
 {
 "textRaw": "`lineOffset` {number} Specifies the line number offset that is displayed in stack traces produced by this script. **Default:** `0`.",
 "name": "lineOffset",
 "type": "number",
 "default": "`0`",
 "desc": "Specifies the line number offset that is displayed in stack traces produced by this script."
 },
 {
 "textRaw": "`columnOffset` {number} Specifies the column number offset that is displayed in stack traces produced by this script. **Default:** `0`.",
 "name": "columnOffset",
 "type": "number",
 "default": "`0`",
 "desc": "Specifies the column number offset that is displayed in stack traces produced by this script."
 },
 {
 "textRaw": "`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`.",
 "name": "displayErrors",
 "type": "boolean",
 "default": "`true`",
 "desc": "When `true`, if an [`Error`][] occurs while compiling the `code`, the line of code causing the error is attached to the stack trace."
 },
 {
 "textRaw": "`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.",
 "name": "timeout",
 "type": "integer",
 "desc": "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."
 },
 {
 "textRaw": "`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. **Default:** `false`.",
 "name": "breakOnSigint",
 "type": "boolean",
 "default": "`false`",
 "desc": "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."
 },
 {
 "textRaw": "`cachedData` {Buffer|TypedArray|DataView} Provides an optional `Buffer` or `TypedArray`, or `DataView` with V8's code cache data for the supplied source. When supplied, the `cachedDataRejected` value will be set to either `true` or `false` depending on acceptance of the data by V8.",
 "name": "cachedData",
 "type": "Buffer|TypedArray|DataView",
 "desc": "Provides an optional `Buffer` or `TypedArray`, or `DataView` with V8's code cache data for the supplied source. When supplied, the `cachedDataRejected` value will be set to either `true` or `false` depending on acceptance of the data by V8."
 },
 {
 "textRaw": "`produceCachedData` {boolean} When `true` and no `cachedData` is present, V8 will attempt to produce code cache data for `code`. Upon success, a `Buffer` with V8's code cache data will be produced and stored in the `cachedData` property of the returned `vm.Script` instance. The `cachedDataProduced` value will be set to either `true` or `false` depending on whether code cache data is produced successfully. This option is **deprecated** in favor of `script.createCachedData()`. **Default:** `false`.",
 "name": "produceCachedData",
 "type": "boolean",
 "default": "`false`",
 "desc": "When `true` and no `cachedData` is present, V8 will attempt to produce code cache data for `code`. Upon success, a `Buffer` with V8's code cache data will be produced and stored in the `cachedData` property of the returned `vm.Script` instance. The `cachedDataProduced` value will be set to either `true` or `false` depending on whether code cache data is produced successfully. This option is **deprecated** in favor of `script.createCachedData()`."
 },
 {
 "textRaw": "`importModuleDynamically` {Function} Called during evaluation of this module when `import()` is called. If this option is not specified, calls to `import()` will reject with [`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`][]. This option is part of the experimental modules API, and should not be considered stable.",
 "name": "importModuleDynamically",
 "type": "Function",
 "desc": "Called during evaluation of this module when `import()` is called. If this option is not specified, calls to `import()` will reject with [`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`][]. This option is part of the experimental modules API, and should not be considered stable.",
 "options": [
 {
 "textRaw": "`specifier` {string} specifier passed to `import()`",
 "name": "specifier",
 "type": "string",
 "desc": "specifier passed to `import()`"
 },
 {
 "textRaw": "`module` {vm.Module}",
 "name": "module",
 "type": "vm.Module"
 },
 {
 "textRaw": "Returns: {Module Namespace Object|vm.Module} Returning a `vm.Module` is recommended in order to take advantage of error tracking, and to avoid issues with namespaces that contain `then` function exports.",
 "name": "return",
 "type": "Module Namespace Object|vm.Module",
 "desc": "Returning a `vm.Module` is recommended in order to take advantage of error tracking, and to avoid issues with namespaces that contain `then` function exports."
 }
 ]
 }
 ]
 }
 ]
 }
 ],
 "desc": "The <code>vm.runInContext()</code> method compiles <code>code</code>, runs it within the context of\nthe <code>contextifiedObject</code>, then returns the result. Running code does not have\naccess to the local scope. The <code>contextifiedObject</code> object must have been\npreviously <a href=\"#vm_what_does_it_mean_to_contextify_an_object\">contextified</a> using the <a href=\"#vm_vm_createcontext_contextobject_options\"><code>vm.createContext()</code></a> method.\nIf <code>options</code> is a string, then it specifies the filename.\nThe following example compiles and executes different scripts using a single\n<a href=\"#vm_what_does_it_mean_to_contextify_an_object\">contextified</a> object:\n<pre><code class=\"language-js\">const vm = require('vm');\n\nconst contextObject = { globalVar: 1 };\nvm.createContext(contextObject);\n\nfor (let i = 0; i &#x3C; 10; ++i) {\n vm.runInContext('globalVar *= 2;', contextObject);\n}\nconsole.log(contextObject);\n// Prints: { globalVar: 1024 }\n</code></pre>"
 },
 {
 "textRaw": "`vm.runInNewContext(code[, contextObject[, options]])`",
 "type": "method",
 "name": "runInNewContext",
 "meta": {
 "added": [
 "v0.3.1"
 ],
 "changes": [
 {
 "version": "v10.0.0",
 "pr-url": "https://github.com/nodejs/node/pull/19016",
 "description": "The `contextCodeGeneration` option is supported now."
 },
 {
 "version": "v6.3.0",
 "pr-url": "https://github.com/nodejs/node/pull/6635",
 "description": "The `breakOnSigint` option is supported now."
 }
 ]
 },
 "signatures": [
 {
 "return": {
 "textRaw": "Returns: {any} the result of the very last statement executed in the script.",
 "name": "return",
 "type": "any",
 "desc": "the result of the very last statement executed in the script."
 },
 "params": [
 {
 "textRaw": "`code` {string} The JavaScript code to compile and run.",
 "name": "code",
 "type": "string",
 "desc": "The JavaScript code to compile and run."
 },
 {
 "textRaw": "`contextObject` {Object} An object that will be [contextified][]. If `undefined`, a new object will be created.",
 "name": "contextObject",
 "type": "Object",
 "desc": "An object that will be [contextified][]. If `undefined`, a new object will be created."
 },
 {
 "textRaw": "`options` {Object|string}",
 "name": "options",
 "type": "Object|string",
 "options": [
 {
 "textRaw": "`filename` {string} Specifies the filename used in stack traces produced by this script. **Default:** `'evalmachine.<anonymous>'`.",
 "name": "filename",
 "type": "string",
 "default": "`'evalmachine.<anonymous>'`",
 "desc": "Specifies the filename used in stack traces produced by this script."
 },
 {
 "textRaw": "`lineOffset` {number} Specifies the line number offset that is displayed in stack traces produced by this script. **Default:** `0`.",
 "name": "lineOffset",
 "type": "number",
 "default": "`0`",
 "desc": "Specifies the line number offset that is displayed in stack traces produced by this script."
 },
 {
 "textRaw": "`columnOffset` {number} Specifies the column number offset that is displayed in stack traces produced by this script. **Default:** `0`.",
 "name": "columnOffset",
 "type": "number",
 "default": "`0`",
 "desc": "Specifies the column number offset that is displayed in stack traces produced by this script."
 },
 {
 "textRaw": "`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`.",
 "name": "displayErrors",
 "type": "boolean",
 "default": "`true`",
 "desc": "When `true`, if an [`Error`][] occurs while compiling the `code`, the line of code causing the error is attached to the stack trace."
 },
 {
 "textRaw": "`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.",
 "name": "timeout",
 "type": "integer",
 "desc": "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."
 },
 {
 "textRaw": "`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. **Default:** `false`.",
 "name": "breakOnSigint",
 "type": "boolean",
 "default": "`false`",
 "desc": "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."
 },
 {
 "textRaw": "`contextName` {string} Human-readable name of the newly created context. **Default:** `'VM Context i'`, where `i` is an ascending numerical index of the created context.",
 "name": "contextName",
 "type": "string",
 "default": "`'VM Context i'`, where `i` is an ascending numerical index of the created context",
 "desc": "Human-readable name of the newly created context."
 },
 {
 "textRaw": "`contextOrigin` {string} [Origin][origin] corresponding to the newly created context for display purposes. The origin should be formatted like a URL, but with only the scheme, host, and port (if necessary), like the value of the [`url.origin`][] property of a [`URL`][] object. Most notably, this string should omit the trailing slash, as that denotes a path. **Default:** `''`.",
 "name": "contextOrigin",
 "type": "string",
 "default": "`''`",
 "desc": "[Origin][origin] corresponding to the newly created context for display purposes. The origin should be formatted like a URL, but with only the scheme, host, and port (if necessary), like the value of the [`url.origin`][] property of a [`URL`][] object. Most notably, this string should omit the trailing slash, as that denotes a path."
 },
 {
 "textRaw": "`contextCodeGeneration` {Object}",
 "name": "contextCodeGeneration",
 "type": "Object",
 "options": [
 {
 "textRaw": "`strings` {boolean} If set to false any calls to `eval` or function constructors (`Function`, `GeneratorFunction`, etc) will throw an `EvalError`. **Default:** `true`.",
 "name": "strings",
 "type": "boolean",
 "default": "`true`",
 "desc": "If set to false any calls to `eval` or function constructors (`Function`, `GeneratorFunction`, etc) will throw an `EvalError`."
 },
 {
 "textRaw": "`wasm` {boolean} If set to false any attempt to compile a WebAssembly module will throw a `WebAssembly.CompileError`. **Default:** `true`.",
 "name": "wasm",
 "type": "boolean",
 "default": "`true`",
 "desc": "If set to false any attempt to compile a WebAssembly module will throw a `WebAssembly.CompileError`."
 }
 ]
 },
 {
 "textRaw": "`cachedData` {Buffer|TypedArray|DataView} Provides an optional `Buffer` or `TypedArray`, or `DataView` with V8's code cache data for the supplied source. When supplied, the `cachedDataRejected` value will be set to either `true` or `false` depending on acceptance of the data by V8.",
 "name": "cachedData",
 "type": "Buffer|TypedArray|DataView",
 "desc": "Provides an optional `Buffer` or `TypedArray`, or `DataView` with V8's code cache data for the supplied source. When supplied, the `cachedDataRejected` value will be set to either `true` or `false` depending on acceptance of the data by V8."
 },
 {
 "textRaw": "`produceCachedData` {boolean} When `true` and no `cachedData` is present, V8 will attempt to produce code cache data for `code`. Upon success, a `Buffer` with V8's code cache data will be produced and stored in the `cachedData` property of the returned `vm.Script` instance. The `cachedDataProduced` value will be set to either `true` or `false` depending on whether code cache data is produced successfully. This option is **deprecated** in favor of `script.createCachedData()`. **Default:** `false`.",
 "name": "produceCachedData",
 "type": "boolean",
 "default": "`false`",
 "desc": "When `true` and no `cachedData` is present, V8 will attempt to produce code cache data for `code`. Upon success, a `Buffer` with V8's code cache data will be produced and stored in the `cachedData` property of the returned `vm.Script` instance. The `cachedDataProduced` value will be set to either `true` or `false` depending on whether code cache data is produced successfully. This option is **deprecated** in favor of `script.createCachedData()`."
 },
 {
 "textRaw": "`importModuleDynamically` {Function} Called during evaluation of this module when `import()` is called. If this option is not specified, calls to `import()` will reject with [`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`][]. This option is part of the experimental modules API, and should not be considered stable.",
 "name": "importModuleDynamically",
 "type": "Function",
 "desc": "Called during evaluation of this module when `import()` is called. If this option is not specified, calls to `import()` will reject with [`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`][]. This option is part of the experimental modules API, and should not be considered stable.",
 "options": [
 {
 "textRaw": "`specifier` {string} specifier passed to `import()`",
 "name": "specifier",
 "type": "string",
 "desc": "specifier passed to `import()`"
 },
 {
 "textRaw": "`module` {vm.Module}",
 "name": "module",
 "type": "vm.Module"
 },
 {
 "textRaw": "Returns: {Module Namespace Object|vm.Module} Returning a `vm.Module` is recommended in order to take advantage of error tracking, and to avoid issues with namespaces that contain `then` function exports.",
 "name": "return",
 "type": "Module Namespace Object|vm.Module",
 "desc": "Returning a `vm.Module` is recommended in order to take advantage of error tracking, and to avoid issues with namespaces that contain `then` function exports."
 }
 ]
 }
 ]
 }
 ]
 }
 ],
 "desc": "The <code>vm.runInNewContext()</code> first contextifies the given <code>contextObject</code> (or\ncreates a new <code>contextObject</code> if passed as <code>undefined</code>), compiles the <code>code</code>,\nruns it within the created context, then returns the result. Running code\ndoes not have access to the local scope.\nIf <code>options</code> is a string, then it specifies the filename.\nThe following example compiles and executes code that increments a global\nvariable and sets a new one. These globals are contained in the <code>contextObject</code>.\n<pre><code class=\"language-js\">const vm = require('vm');\n\nconst contextObject = {\n animal: 'cat',\n count: 2\n};\n\nvm.runInNewContext('count += 1; name = \"kitty\"', contextObject);\nconsole.log(contextObject);\n// Prints: { animal: 'cat', count: 3, name: 'kitty' }\n</code></pre>"
 },
 {
 "textRaw": "`vm.runInThisContext(code[, options])`",
 "type": "method",
 "name": "runInThisContext",
 "meta": {
 "added": [
 "v0.3.1"
 ],
 "changes": [
 {
 "version": "v6.3.0",
 "pr-url": "https://github.com/nodejs/node/pull/6635",
 "description": "The `breakOnSigint` option is supported now."
 }
 ]
 },
 "signatures": [
 {
 "return": {
 "textRaw": "Returns: {any} the result of the very last statement executed in the script.",
 "name": "return",
 "type": "any",
 "desc": "the result of the very last statement executed in the script."
 },
 "params": [
 {
 "textRaw": "`code` {string} The JavaScript code to compile and run.",
 "name": "code",
 "type": "string",
 "desc": "The JavaScript code to compile and run."
 },
 {
 "textRaw": "`options` {Object|string}",
 "name": "options",
 "type": "Object|string",
 "options": [
 {
 "textRaw": "`filename` {string} Specifies the filename used in stack traces produced by this script. **Default:** `'evalmachine.<anonymous>'`.",
 "name": "filename",
 "type": "string",
 "default": "`'evalmachine.<anonymous>'`",
 "desc": "Specifies the filename used in stack traces produced by this script."
 },
 {
 "textRaw": "`lineOffset` {number} Specifies the line number offset that is displayed in stack traces produced by this script. **Default:** `0`.",
 "name": "lineOffset",
 "type": "number",
 "default": "`0`",
 "desc": "Specifies the line number offset that is displayed in stack traces produced by this script."
 },
 {
 "textRaw": "`columnOffset` {number} Specifies the column number offset that is displayed in stack traces produced by this script. **Default:** `0`.",
 "name": "columnOffset",
 "type": "number",
 "default": "`0`",
 "desc": "Specifies the column number offset that is displayed in stack traces produced by this script."
 },
 {
 "textRaw": "`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`.",
 "name": "displayErrors",
 "type": "boolean",
 "default": "`true`",
 "desc": "When `true`, if an [`Error`][] occurs while compiling the `code`, the line of code causing the error is attached to the stack trace."
 },
 {
 "textRaw": "`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.",
 "name": "timeout",
 "type": "integer",
 "desc": "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."
 },
 {
 "textRaw": "`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. **Default:** `false`.",
 "name": "breakOnSigint",
 "type": "boolean",
 "default": "`false`",
 "desc": "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."
 },
 {
 "textRaw": "`cachedData` {Buffer|TypedArray|DataView} Provides an optional `Buffer` or `TypedArray`, or `DataView` with V8's code cache data for the supplied source. When supplied, the `cachedDataRejected` value will be set to either `true` or `false` depending on acceptance of the data by V8.",
 "name": "cachedData",
 "type": "Buffer|TypedArray|DataView",
 "desc": "Provides an optional `Buffer` or `TypedArray`, or `DataView` with V8's code cache data for the supplied source. When supplied, the `cachedDataRejected` value will be set to either `true` or `false` depending on acceptance of the data by V8."
 },
 {
 "textRaw": "`produceCachedData` {boolean} When `true` and no `cachedData` is present, V8 will attempt to produce code cache data for `code`. Upon success, a `Buffer` with V8's code cache data will be produced and stored in the `cachedData` property of the returned `vm.Script` instance. The `cachedDataProduced` value will be set to either `true` or `false` depending on whether code cache data is produced successfully. This option is **deprecated** in favor of `script.createCachedData()`. **Default:** `false`.",
 "name": "produceCachedData",
 "type": "boolean",
 "default": "`false`",
 "desc": "When `true` and no `cachedData` is present, V8 will attempt to produce code cache data for `code`. Upon success, a `Buffer` with V8's code cache data will be produced and stored in the `cachedData` property of the returned `vm.Script` instance. The `cachedDataProduced` value will be set to either `true` or `false` depending on whether code cache data is produced successfully. This option is **deprecated** in favor of `script.createCachedData()`."
 },
 {
 "textRaw": "`importModuleDynamically` {Function} Called during evaluation of this module when `import()` is called. If this option is not specified, calls to `import()` will reject with [`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`][]. This option is part of the experimental modules API, and should not be considered stable.",
 "name": "importModuleDynamically",
 "type": "Function",
 "desc": "Called during evaluation of this module when `import()` is called. If this option is not specified, calls to `import()` will reject with [`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`][]. This option is part of the experimental modules API, and should not be considered stable.",
 "options": [
 {
 "textRaw": "`specifier` {string} specifier passed to `import()`",
 "name": "specifier",
 "type": "string",
 "desc": "specifier passed to `import()`"
 },
 {
 "textRaw": "`module` {vm.Module}",
 "name": "module",
 "type": "vm.Module"
 },
 {
 "textRaw": "Returns: {Module Namespace Object|vm.Module} Returning a `vm.Module` is recommended in order to take advantage of error tracking, and to avoid issues with namespaces that contain `then` function exports.",
 "name": "return",
 "type": "Module Namespace Object|vm.Module",
 "desc": "Returning a `vm.Module` is recommended in order to take advantage of error tracking, and to avoid issues with namespaces that contain `then` function exports."
 }
 ]
 }
 ]
 }
 ]
 }
 ],
 "desc": "<code>vm.runInThisContext()</code> compiles <code>code</code>, runs it within the context of the\ncurrent <code>global</code> and returns the result. Running code does not have access to\nlocal scope, but does have access to the current <code>global</code> object.\nIf <code>options</code> is a string, then it specifies the filename.\nThe following example illustrates using both <code>vm.runInThisContext()</code> and\nthe JavaScript <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval\"><code>eval()</code></a> function to run the same code:\n\n<pre><code class=\"language-js\">const vm = require('vm');\nlet localVar = 'initial value';\n\nconst vmResult = vm.runInThisContext('localVar = \"vm\";');\nconsole.log(`vmResult: '${vmResult}', localVar: '${localVar}'`);\n// Prints: vmResult: 'vm', localVar: 'initial value'\n\nconst evalResult = eval('localVar = \"eval\";');\nconsole.log(`evalResult: '${evalResult}', localVar: '${localVar}'`);\n// Prints: evalResult: 'eval', localVar: 'eval'\n</code></pre>\nBecause <code>vm.runInThisContext()</code> does not have access to the local scope,\n<code>localVar</code> is unchanged. In contrast, <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval\"><code>eval()</code></a> does have access to the\nlocal scope, so the value <code>localVar</code> is changed. In this way\n<code>vm.runInThisContext()</code> is much like an <a href=\"https://es5.github.io/#x10.4.2\">indirect <code>eval()</code> call</a>, e.g.\n<code>(0,eval)('code')</code>.\n<h2>Example: Running an HTTP server within a VM</h2>\nWhen using either <a href=\"#vm_script_runinthiscontext_options\"><code>script.runInThisContext()</code></a> or\n<a href=\"#vm_vm_runinthiscontext_code_options\"><code>vm.runInThisContext()</code></a>, the code is executed within the current V8 global\ncontext. The code passed to this VM context will have its own isolated scope.\nIn order to run a simple web server using the <code>http</code> module the code passed to\nthe context must either call <code>require('http')</code> on its own, or have a reference\nto the <code>http</code> module passed to it. For instance:\n<pre><code class=\"language-js\">'use strict';\nconst vm = require('vm');\n\nconst code = `\n((require) => {\n const http = require('http');\n\n http.createServer((request, response) => {\n response.writeHead(200, { 'Content-Type': 'text/plain' });\n response.end('Hello World\\\\n');\n }).listen(8124);\n\n console.log('Server running at http://127.0.0.1:8124/');\n})`;\n\nvm.runInThisContext(code)(require);\n</code></pre>\nThe <code>require()</code> in the above case shares the state with the context it is\npassed from. This may introduce risks when untrusted code is executed, e.g.\naltering objects in the context in unwanted ways."
 }
 ],
 "modules": [
 {
 "textRaw": "What does it mean to \"contextify\" an object?",
 "name": "what_does_it_mean_to_\"contextify\"_an_object?",
 "desc": "All JavaScript executed within Node.js runs within the scope of a \"context\".\nAccording to the <a href=\"https://v8.dev/docs/embed#contexts\">V8 Embedder's Guide</a>:\n<blockquote>\nIn V8, a context is an execution environment that allows separate, unrelated,\nJavaScript applications to run in a single instance of V8. You must explicitly\nspecify the context in which you want any JavaScript code to be run.\n</blockquote>\nWhen the method <code>vm.createContext()</code> is called, the <code>contextObject</code> argument\n(or a newly-created object if <code>contextObject</code> is <code>undefined</code>) is associated\ninternally with a new instance of a V8 Context. This V8 Context provides the\n<code>code</code> run using the <code>vm</code> module's methods with an isolated global environment\nwithin which it can operate. The process of creating the V8 Context and\nassociating it with the <code>contextObject</code> is what this document refers to as\n\"contextifying\" the object.",
 "type": "module",
 "displayName": "What does it mean to \"contextify\" an object?"
 },
 {
 "textRaw": "Timeout limitations when using `process.nextTick()`, promises, and `queueMicrotask()`",
 "name": "timeout_limitations_when_using_`process.nexttick()`,_promises,_and_`queuemicrotask()`",
 "desc": "Because of the internal mechanics of how the <code>process.nextTick()</code> queue and\nthe microtask queue that underlies Promises are implemented within V8 and\nNode.js, it is possible for code running within a context to \"escape\" the\n<code>timeout</code> set using <code>vm.runInContext()</code>, <code>vm.runInNewContext()</code>, and\n<code>vm.runInThisContext()</code>.\nFor example, the following code executed by <code>vm.runInNewContext()</code> with a\ntimeout of 5 milliseconds schedules an infinite loop to run after a promise\nresolves. The scheduled loop is never interrupted by the timeout:\n<pre><code class=\"language-js\">const vm = require('vm');\n\nfunction loop() {\n while (1) console.log(Date.now());\n}\n\nvm.runInNewContext(\n 'Promise.resolve().then(loop);',\n { loop, console },\n { timeout: 5 }\n);\n</code></pre>\nThis issue also occurs when the <code>loop()</code> call is scheduled using\nthe <code>process.nextTick()</code> and <code>queueMicrotask()</code> functions.\nThis issue occurs because all contexts share the same microtask and nextTick\nqueues.",
 "type": "module",
 "displayName": "Timeout limitations when using `process.nextTick()`, promises, and `queueMicrotask()`"
 }
 ],
 "type": "module",
 "displayName": "vm"
 }
 ]
}

MR SKB