kotlin-node/node.vm/Script

Script

external class Script(source)

Instances of the vm.Script class contain precompiled scripts that can be executed in specific contexts.

Since

v0.3.1

Constructors

Script

constructor(code: String)

constructor(code: String, options: ScriptOptions = definedExternally)

constructor(code: String, options: String = definedExternally)

Properties

cachedData

var cachedData: Buffer<*>?

cachedDataProduced

var cachedDataProduced: Boolean?

cachedDataRejected

var cachedDataRejected: Boolean?

When cachedData is supplied to create the vm.Script, this value will be set to either true or false depending on acceptance of the data by V8. Otherwise the value is undefined.

sourceMapURL

var sourceMapURL: String?

When the script is compiled from a source that contains a source map magic comment, this property will be set to the URL of the source map.

Functions

createCachedData

fun createCachedData(): Buffer<*>

Creates a code cache that can be used with the Script constructor's cachedData option. Returns a Buffer. This method may be called at any time and any number of times.

runInContext

fun runInContext(contextifiedObject: Context, options: RunningScriptOptions = definedExternally): Any?

Runs the compiled code contained by the vm.Script object within the given contextifiedObject and returns the result. Running code does not have access to local scope.

runInNewContext

fun runInNewContext(): Any?

fun runInNewContext(contextObject: Double = definedExternally, options: RunningScriptInNewContextOptions = definedExternally): Any?

fun runInNewContext(contextObject: Context = definedExternally, options: RunningScriptInNewContextOptions = definedExternally): Any?

This method is a shortcut to script.runInContext(vm.createContext(options), options). It does several things at once:

runInThisContext

fun runInThisContext(options: RunningScriptOptions = definedExternally): Any?

Runs the compiled code contained by the vm.Script within the context of the current global object. Running code does not have access to local scope, but does have access to the current global object.