graalvm-js/elide.runtime.lang.javascript/SyntheticJSModule

SyntheticJSModule

interface SyntheticJSModule<T> : JSModuleProvider, CommonJSModuleProvider<T>

Synthetic JavaScript Module

Describes a "synthetic" JavaScript module, which is a module that surfaces as a built-in for guest JavaScript code, and which is typically implemented in Kotlin or generally on JVM. Synthetic modules are resolved at their built-in name and routed to the appropriate implementation.

This interface defines the API contract which is used to understand the module and to dynamically load it into a suite of exports. It is not a requirement that the synthetic facade for a module be the same as the module's actual implementation.

Parameters

Type/shape of the module.

Types

ExportedSymbol

@JvmRecord

data class ExportedSymbol(val name: String, val kind: SyntheticJSModule.ExportKind, val from: String? = null) : Record

Describes a symbol which is exported from a synthetic module; such symbols are used when initializing the module object in ESM mode, and used for generating bindings in string form for CJS mode.

ExportKind

enum ExportKind : Enum<SyntheticJSModule.ExportKind>

Describes different types of exports.