external fun compileFunction( code: String, params: <Error class: unknown class><String> = definedExternally, options: CompileFunctionOptions = definedExternally): CompileFunctionResult

Compiles the given code into the provided context (if no context is supplied, the current context is used), and returns it wrapped inside a function with the given params.

createContext

external fun createContext(): Context

external fun createContext(contextObject: Double = definedExternally, options: CreateContextOptions = definedExternally): Context

external fun createContext(contextObject: Context = definedExternally, options: CreateContextOptions = definedExternally): Context

If the given contextObject is an object, the vm.createContext() method will prepare that object and return a reference to it so that it can be used in calls to {@link runInContext} or script.runInContext(). Inside such scripts, the global object will be wrapped by the contextObject, retaining all of its existing properties but also having the built-in objects and functions any standard global object has. Outside of scripts run by the vm module, global variables will remain unchanged.

isContext

external fun isContext(sandbox: Context): Boolean

Returns true if the given object object has been contextified using {@link createContext}, or if it's the global object of a context created using vm.constants.DONT_CONTEXTIFY.

measureMemory

suspend external fun measureMemory(options: MeasureMemoryOptions = definedExternally): MemoryMeasurement

measureMemoryAsync

external fun measureMemoryAsync(options: MeasureMemoryOptions = definedExternally): <Error class: unknown class><MemoryMeasurement>

Measure the memory known to V8 and used by all contexts known to the current V8 isolate, or the main context.

runInContext

external fun runInContext(code: String, contextifiedObject: Context): Any?

external fun runInContext(code: String, contextifiedObject: Context, options: String = definedExternally): Any?

external fun runInContext(code: String, contextifiedObject: Context, options: RunningCodeOptions = definedExternally): 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 {@link createContext} method.

runInNewContext

external fun runInNewContext(code: String): Any?

external fun runInNewContext(code: String, contextObject: Double = definedExternally, options: String = definedExternally): Any?

external fun runInNewContext( code: String, contextObject: Double = definedExternally, options: RunningCodeInNewContextOptions = definedExternally): Any?

external fun runInNewContext(code: String, contextObject: Context = definedExternally, options: String = definedExternally): Any?

external fun runInNewContext( code: String, contextObject: Context = definedExternally, options: RunningCodeInNewContextOptions = definedExternally): Any?

This method is a shortcut to (new vm.Script(code, options)).runInContext(vm.createContext(options), options). If options is a string, then it specifies the filename.

runInThisContext

external fun runInThisContext(code: String): Any?

external fun runInThisContext(code: String, options: String = definedExternally): Any?

external fun runInThisContext(code: String, options: RunningCodeOptions = definedExternally): Any?

vm.runInThisContext() compiles code, runs it within the context of the current global and returns the result. Running code does not have access to local scope, but does have access to the current global object.