113 lines
4.8 KiB
TypeScript
Executable file
113 lines
4.8 KiB
TypeScript
Executable file
declare module 'vm' {
|
|
interface Context {
|
|
[key: string]: any;
|
|
}
|
|
interface BaseOptions {
|
|
/**
|
|
* Specifies the filename used in stack traces produced by this script.
|
|
* Default: `''`.
|
|
*/
|
|
filename?: string | undefined;
|
|
/**
|
|
* Specifies the line number offset that is displayed in stack traces produced by this script.
|
|
* Default: `0`.
|
|
*/
|
|
lineOffset?: number | undefined;
|
|
/**
|
|
* Specifies the column number offset that is displayed in stack traces produced by this script.
|
|
* @default 0
|
|
*/
|
|
columnOffset?: number | undefined;
|
|
}
|
|
interface ScriptOptions extends BaseOptions {
|
|
displayErrors?: boolean | undefined;
|
|
timeout?: number | undefined;
|
|
cachedData?: Buffer | undefined;
|
|
/** @deprecated in favor of `script.createCachedData()` */
|
|
produceCachedData?: boolean | undefined;
|
|
}
|
|
interface RunningScriptOptions extends BaseOptions {
|
|
/**
|
|
* 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`.
|
|
*/
|
|
displayErrors?: boolean | undefined;
|
|
/**
|
|
* 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.
|
|
*/
|
|
timeout?: number | undefined;
|
|
/**
|
|
* 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`.
|
|
*/
|
|
breakOnSigint?: boolean | undefined;
|
|
}
|
|
interface CompileFunctionOptions extends BaseOptions {
|
|
/**
|
|
* Provides an optional data with V8's code cache data for the supplied source.
|
|
*/
|
|
cachedData?: Buffer | undefined;
|
|
/**
|
|
* Specifies whether to produce new cache data.
|
|
* Default: `false`,
|
|
*/
|
|
produceCachedData?: boolean | undefined;
|
|
/**
|
|
* The sandbox/context in which the said function should be compiled in.
|
|
*/
|
|
parsingContext?: Context | undefined;
|
|
|
|
/**
|
|
* An array containing a collection of context extensions (objects wrapping the current scope) to be applied while compiling
|
|
*/
|
|
contextExtensions?: Object[] | undefined;
|
|
}
|
|
|
|
interface CreateContextOptions {
|
|
/**
|
|
* Human-readable name of the newly created context.
|
|
* @default 'VM Context i' Where i is an ascending numerical index of the created context.
|
|
*/
|
|
name?: string | undefined;
|
|
/**
|
|
* Corresponds 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 ''
|
|
*/
|
|
origin?: string | undefined;
|
|
codeGeneration?: {
|
|
/**
|
|
* If set to false any calls to eval or function constructors (Function, GeneratorFunction, etc)
|
|
* will throw an EvalError.
|
|
* @default true
|
|
*/
|
|
strings?: boolean | undefined;
|
|
/**
|
|
* If set to false any attempt to compile a WebAssembly module will throw a WebAssembly.CompileError.
|
|
* @default true
|
|
*/
|
|
wasm?: boolean | undefined;
|
|
} | undefined;
|
|
}
|
|
|
|
class Script {
|
|
constructor(code: string, options?: ScriptOptions);
|
|
runInContext(contextifiedSandbox: Context, options?: RunningScriptOptions): any;
|
|
runInNewContext(sandbox?: Context, options?: RunningScriptOptions): any;
|
|
runInThisContext(options?: RunningScriptOptions): any;
|
|
createCachedData(): Buffer;
|
|
cachedDataRejected?: boolean | undefined;
|
|
}
|
|
function createContext(sandbox?: Context, options?: CreateContextOptions): Context;
|
|
function isContext(sandbox: Context): boolean;
|
|
function runInContext(code: string, contextifiedSandbox: Context, options?: RunningScriptOptions | string): any;
|
|
function runInNewContext(code: string, sandbox?: Context, options?: RunningScriptOptions | string): any;
|
|
function runInThisContext(code: string, options?: RunningScriptOptions | string): any;
|
|
function compileFunction(code: string, params?: ReadonlyArray<string>, options?: CompileFunctionOptions): Function;
|
|
}
|