kotlin-node/node.vm/SourceTextModule

SourceTextModule

external class SourceTextModule : Module(source)

This feature is only available with the --experimental-vm-modules command flag enabled.

The vm.SourceTextModule class provides the Source Text Module Record as defined in the ECMAScript specification.

Since

v9.6.0

Constructors

SourceTextModule

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

Creates a new SourceTextModule instance.

Properties

context

var context: Context

dependencySpecifiers

val dependencySpecifiers: ReadonlyArray<String>

error

var error: Any?

If the module.status is 'errored', this property contains the exception thrown by the module during evaluation. If the status is anything else, accessing this property will result in a thrown exception.

identifier

var identifier: String

The identifier of the current module, as set in the constructor.

moduleRequests

val moduleRequests: ReadonlyArray<ModuleRequest>

The requested import dependencies of this module. The returned array is frozen to disallow any changes to it.

namespace

var namespace: Any

The namespace object of the module. This is only available after linking (module.link()) has completed.

status

var status: ModuleStatus

The current status of the module. Will be one of:

Functions

evaluate

suspend fun evaluate(options: ModuleEvaluateOptions = definedExternally): Void

evaluateAsync

fun evaluateAsync(options: ModuleEvaluateOptions = definedExternally): Promise<Void>

Evaluate the module.

hasAsyncGraph

fun hasAsyncGraph(): Boolean

Iterates over the dependency graph and returns true if any module in its dependencies or this module itself contains top-level await expressions, otherwise returns false.

hasTopLevelAwait

fun hasTopLevelAwait(): Boolean

Returns whether the module itself contains any top-level await expressions.

instantiate

fun instantiate()

Instantiate the module with the linked requested modules.

link

suspend fun link(linker: ModuleLinker): Void

linkAsync

fun linkAsync(linker: ModuleLinker): Promise<Void>

Link module dependencies. This method must be called before evaluation, and can only be called once per module.

linkRequests

fun linkRequests(modules: ReadonlyArray<Module>)

Link module dependencies. This method must be called before evaluation, and can only be called once per module.