Interface ModuleRuntime

Live parts of a module, created by activate. Each key names a declared spec.

interface ModuleRuntime {
    jobs?: Readonly<Record<string, JobRunner>>;
    routes?: Readonly<Record<string, RouteHandler>>;
    sockets?: Readonly<Record<string, SocketHandler>>;
    verbs?: Readonly<Record<string, CliVerbHandler>>;
    dispose?(): void | Promise<void>;
    status?(): Readonly<Record<string, number | string | boolean | null>>;
}

Index

Properties

jobs? routes? sockets? verbs?

Methods

dispose? status?

Properties

`Optional` `Readonly`jobs

jobs?: Readonly<Record<string, JobRunner>>

`Optional` `Readonly`routes

routes?: Readonly<Record<string, RouteHandler>>

`Optional` `Readonly`sockets

sockets?: Readonly<Record<string, SocketHandler>>

`Optional` `Readonly`verbs

verbs?: Readonly<Record<string, CliVerbHandler>>

Methods

`Optional`dispose

dispose?(): void | Promise<void>
Called once when the host stops the module, after its in-flight work drains.

Returns void | Promise<void>
- Defined in packages/app-core/src/module.ts:191

`Optional`status

status?(): Readonly<Record<string, number | string | boolean | null>>
Live counters for the host's health and stats surfaces. Never loads a model.

Returns Readonly<Record<string, number | string | boolean | null>>
- Defined in packages/app-core/src/module.ts:189