Nodejs/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2024-11-21 10:59:27 +00:00
Code Issues Actions 25 Packages Projects Releases Wiki Activity

typings: lib/internal/vm.js

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/50112
Reviewed-By: Yagiz Nizipli <yagiz.nizipli@sentry.io>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
This commit is contained in:
Geoffrey Booth 2024-02-18 17:19:44 -08:00 committed by GitHub
parent fe2299089d
commit 0550bc149c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 58 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
lib/internal/vm.js
View File

@ -31,10 +31,23 @@ const {
},
} = internalBinding('util');
/**
* Checks if the given object is a context object.
* @param {object} object - The object to check.
* @returns {boolean} - Returns true if the object is a context object, else false.
*/
function isContext(object) {
return object[contextify_context_private_symbol] !== undefined;
}
/**
* Retrieves the host-defined option ID based on the provided importModuleDynamically and hint.
* @param {import('internal/modules/esm/utils').ImportModuleDynamicallyCallback | undefined} importModuleDynamically -
* The importModuleDynamically function or undefined.
* @param {string} hint - The hint for the option ID.
* @returns {symbol | import('internal/modules/esm/utils').ImportModuleDynamicallyCallback} - The host-defined option
* ID.
*/
function getHostDefinedOptionId(importModuleDynamically, hint) {
if (importModuleDynamically === vm_dynamic_import_main_context_default ||
importModuleDynamically === vm_dynamic_import_default_internal) {
@ -66,6 +79,12 @@ function getHostDefinedOptionId(importModuleDynamically, hint) {
return Symbol(hint);
}
/**
* Registers a dynamically imported module for customization.
* @param {string} referrer - The path of the referrer module.
* @param {import('internal/modules/esm/utils').ImportModuleDynamicallyCallback} importModuleDynamically - The
* dynamically imported module function to be registered.
*/
function registerImportModuleDynamically(referrer, importModuleDynamically) {
// If it's undefined or certain known symbol, there's no customization so
// no need to register anything.
@ -83,6 +102,25 @@ function registerImportModuleDynamically(referrer, importModuleDynamically) {
});
}
/**
* Compiles a function from the given code string.
* @param {string} code - The code string to compile.
* @param {string} filename - The filename to use for the compiled function.
* @param {number} lineOffset - The line offset to use for the compiled function.
* @param {number} columnOffset - The column offset to use for the compiled function.
* @param {Buffer} [cachedData=undefined] - The cached data to use for the compiled function.
* @param {boolean} produceCachedData - Whether to produce cached data for the compiled function.
* @param {ReturnType<import('vm').createContext} [parsingContext=undefined] - The parsing context to use for the
* compiled function.
* @param {object[]} [contextExtensions=[]] - An array of context extensions to use for the compiled function.
* @param {string[]} [params] - An optional array of parameter names for the compiled function.
* @param {symbol} hostDefinedOptionId - A symbol referenced by the field `host_defined_option_symbol`.
* @param {import('internal/modules/esm/utils').ImportModuleDynamicallyCallback} [importModuleDynamically] -
* A function to use for dynamically importing modules.
* @returns {object} An object containing the compiled function and any associated data.
* @throws {TypeError} If any of the arguments are of the wrong type.
* @throws {ERR_INVALID_ARG_TYPE} If the parsing context is not a valid context object.
*/
function internalCompileFunction(
code, filename, lineOffset, columnOffset,
cachedData, produceCachedData, parsingContext, contextExtensions,
@ -117,6 +155,19 @@ function internalCompileFunction(
return result;
}
/**
* Creates a contextify script.
* @param {string} code - The code of the script.
* @param {string} filename - The filename of the script.
* @param {number} lineOffset - The line offset of the script.
* @param {number} columnOffset - The column offset of the script.
* @param {Buffer} cachedData - The cached data of the script.
* @param {boolean} produceCachedData - Indicates whether to produce cached data.
* @param {object} parsingContext - The parsing context of the script.
* @param {number} hostDefinedOptionId - The host-defined option ID.
* @param {boolean} importModuleDynamically - Indicates whether to import modules dynamically.
* @returns {ContextifyScript} The created contextify script.
*/
function makeContextifyScript(code,
filename,
lineOffset,
@ -147,8 +198,13 @@ function makeContextifyScript(code,
return script;
}
// Internal version of vm.Script.prototype.runInThisContext() which skips
// argument validation.
/**
* Runs a script in the current context.
* Internal version of `vm.Script.prototype.runInThisContext()` which skips argument validation.
* @param {ReturnType<makeContextifyScript>} script - The script to run.
* @param {boolean} displayErrors - Whether to display errors.
* @param {boolean} breakOnFirstLine - Whether to break on the first line.
*/
function runScriptInThisContext(script, displayErrors, breakOnFirstLine) {
return ReflectApply(
runInContext,