@proto-kit/module • Docs

Documentation / @proto-kit/module / RuntimeModule

Class: RuntimeModule<Config>

Base class for runtime modules providing the necessary utilities.

Extends

• ConfigurableModule<Config>

Extended by

Type Parameters

• Config = NoConfig

Constructors

new RuntimeModule()

new RuntimeModule<Config>(): RuntimeModule<Config>

Returns

RuntimeModule<Config>

Overrides

ConfigurableModule.constructor

Defined in

packages/module/src/runtime/RuntimeModule.ts:88

Properties

currentConfig

protected currentConfig: undefined | Config

Store the config separately, so that we can apply additional checks when retrieving it via the getter

Inherited from

ConfigurableModule.currentConfig

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:17

events?

optional events: RuntimeEvents<any> = undefined

Defined in

packages/module/src/runtime/RuntimeModule.ts:84

isRuntimeModule

isRuntimeModule: boolean = true

This property exists only to typecheck that the RuntimeModule was extended correctly in e.g. a decorator. We need at least one non-optional property in this class to make the typechecking work.

Defined in

packages/module/src/runtime/RuntimeModule.ts:78

messages?

optional messages: OutgoingMessages<OutgoingMessagesRecord> = undefined

Defined in

packages/module/src/runtime/RuntimeModule.ts:86

name?

optional name: string

Defined in

packages/module/src/runtime/RuntimeModule.ts:80

parent?

optional parent: RuntimeEnvironment

Defined in

packages/module/src/runtime/RuntimeModule.ts:82

runtimeMethodNames

readonly runtimeMethodNames: string[] = []

Holds all method names that are callable throw transactions

Defined in

packages/module/src/runtime/RuntimeModule.ts:71

presets

static presets: Presets<unknown> = {}

Defined in

packages/module/src/runtime/RuntimeModule.ts:66

Accessors

config

Get Signature

get config(): Config

Returns

Config

Set Signature

set config(config): void

Parameters

• config: Config

Returns

void

Inherited from

ConfigurableModule.config

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:18

network

Get Signature

get network(): NetworkState

Returns

NetworkState

Defined in

packages/module/src/runtime/RuntimeModule.ts:115

transaction

Get Signature

get transaction(): RuntimeTransaction

Returns

RuntimeTransaction

Defined in

packages/module/src/runtime/RuntimeModule.ts:111

Methods

create()

create(childContainerProvider): void

Parameters

• childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

ConfigurableModule.create

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:20

getInputs()

getInputs(): RuntimeMethodExecutionData

Returns

RuntimeMethodExecutionData

Defined in

packages/module/src/runtime/RuntimeModule.ts:98