Interface Runtime

interface Runtime {
    context: RuntimeContext;
    logger: Logger;
    output: Output;
    dispose(): void;
    getComponentConfig<T = unknown>(handle: string): T | undefined;
    getConfig(): Readonly<RuntimeConfig>;
    onConfigChange(listener: ConfigChangeListener): () => void;
    reportMetric(event: MetricEvent): void;
    reportProgress(event: ProgressEvent): void;
    updateConfig(next: RuntimeConfig): void;
}

Index

Properties

context logger output

Methods

dispose getComponentConfig getConfig onConfigChange reportMetric reportProgress updateConfig

Properties

`Readonly`context

context: RuntimeContext

The context passed to components. Throws if session, registry, datastoreManager or sessionManager were not supplied in RuntimeOptions.

`Readonly`logger

logger: Logger

Level-filtered wrapper around the injected logger.

`Readonly`output

output: Output

Methods

dispose

dispose(): void
Returns void
- Defined in runtime.ts:53

getComponentConfig

getComponentConfig<T = unknown>(handle: string): T | undefined
Type Parameters
- T = unknown
Parameters
- handle: string
Returns T | undefined
- Defined in runtime.ts:48

getConfig

getConfig(): Readonly<RuntimeConfig>
Returns Readonly<RuntimeConfig>
- Defined in runtime.ts:47

onConfigChange

onConfigChange(listener: ConfigChangeListener): () => void
Returns an unsubscribe function.
Parameters
- listener: ConfigChangeListener
Returns () => void
- Defined in runtime.ts:52

reportMetric

reportMetric(event: MetricEvent): void
Parameters
- event: MetricEvent
Returns void
- Defined in runtime.ts:46

reportProgress

reportProgress(event: ProgressEvent): void
Parameters
- event: ProgressEvent
Returns void
- Defined in runtime.ts:45

updateConfig

updateConfig(next: RuntimeConfig): void
Full replacement. Throws TypeError on invalid config, keeping the previous config.
Parameters
- next: RuntimeConfig
Returns void
- Defined in runtime.ts:50