kotlin-node/node.module

Package-level declarations

Types

GlobalPreloadContext

sealed external interface GlobalPreloadContext

GlobalPreloadHook

typealias GlobalPreloadHook = (context: GlobalPreloadContext) -> String

ImportAttributes

sealed external interface ImportAttributes : Record<String, String>

InitializeHook

typealias InitializeHook<Data> = (data: Data) -> PromiseResult<Void>

The initialize hook provides a way to define a custom function that runs in the hooks thread when the hooks module is initialized. Initialization happens when the hooks module is registered via register.

LoadFnOutput

sealed external interface LoadFnOutput

LoadHook

typealias LoadHook = (url: String, context: LoadHookContext, nextLoad: (url: String, context: LoadHookContext?) -> PromiseResult<LoadFnOutput>) -> PromiseResult<LoadFnOutput>

The load hook provides a way to define a custom method of determining how a URL should be interpreted, retrieved, and parsed. It is also in charge of validating the import assertion.

LoadHookContext

sealed external interface LoadHookContext

Module

external class Module : Module

ModuleFormat

sealed external interface ModuleFormat

ModuleSource

typealias ModuleSource = Any

RegisterOptions

sealed external interface RegisterOptions<Data>

ResolveFnOutput

sealed external interface ResolveFnOutput

ResolveHook

typealias ResolveHook = (specifier: String, context: ResolveHookContext, nextResolve: (specifier: String, context: ResolveHookContext?) -> PromiseResult<ResolveFnOutput>) -> PromiseResult<ResolveFnOutput>

The resolve hook chain is responsible for resolving file URL for a given module specifier and parent URL, and optionally its format (such as 'module') as a hint to the load hook. If a format is specified, the load hook is ultimately responsible for providing the final format value (and it is free to ignore the hint provided by resolve); if resolve provides a format, a custom load hook is required even if only to pass the value to the Node.js default load hook.

ResolveHookContext

sealed external interface ResolveHookContext

SourceMap

external class SourceMap

SourceMapPayload

sealed external interface SourceMapPayload

SourceMapping

sealed external interface SourceMapping

SourceOrigin

sealed external interface SourceOrigin

Functions

findSourceMap

external fun findSourceMap(path: String, error: JsError = definedExternally): SourceMap

path is the resolved path for the file for which a corresponding source map should be fetched.

syncBuiltinESMExports

external fun syncBuiltinESMExports()

The module.syncBuiltinESMExports() method updates all the live bindings for builtin ES Modules to match the properties of the CommonJS exports. It does not add or remove exported names from the ES Modules.