Interface Service<TConfig>

Generic service interface

interface Service<TConfig = unknown> {
    name: string;
    config: TConfig;
    status: "error" | "running" | "starting" | "idle" | "stopping" | "stopped";
    start(): Promise<void>;
    stop(): Promise<void>;
    restart(): Promise<void>;
    getHealth(): Promise<
        { healthy: boolean; details?: Record<string, unknown> },
    >;
}

Type Parameters

TConfig = unknown

Index

Properties

name config status

Methods

start stop restart? getHealth?

Properties

`Readonly`name

name: string

Service name

`Readonly`config

config: TConfig

Service configuration

`Readonly`status

status: "error" | "running" | "starting" | "idle" | "stopping" | "stopped"

Service status

Methods

start

start(): Promise<void>
Start service

Returns Promise<void>
- Defined in packages/vana-sdk/src/types/generics.ts:370

stop

stop(): Promise<void>
Stop service

Returns Promise<void>
- Defined in packages/vana-sdk/src/types/generics.ts:373

`Optional`restart

restart(): Promise<void>
Restart service

Returns Promise<void>
- Defined in packages/vana-sdk/src/types/generics.ts:376

`Optional`getHealth

getHealth(): Promise<{ healthy: boolean; details?: Record<string, unknown> }>
Get health status

Returns Promise<{ healthy: boolean; details?: Record<string, unknown> }>
- Defined in packages/vana-sdk/src/types/generics.ts:379