Graphorin API reference v0.4.0
Graphorin API reference / @graphorin/server / / GraphorinServer
Interface: GraphorinServer
Defined in: packages/server/src/app.ts:254
Public surface returned by createServer.
Stable
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
agents | readonly | AgentRegistry | - | packages/server/src/app.ts:258 |
app | readonly | Hono<{ Variables: ServerVariables; }> | - | packages/server/src/app.ts:257 |
config | readonly | ServerConfigSpec | - | packages/server/src/app.ts:256 |
consolidator | readonly | | ConsolidatorDaemon | undefined | Optional consolidator daemon — populated when the operator supplied a Consolidator instance via createServer({ consolidator }). Phase 14c integration. | packages/server/src/app.ts:286 |
listeningOn | readonly | | { host: string; port: number; } | undefined | - | packages/server/src/app.ts:261 |
metrics | readonly | MetricRegistry | Phase 14c Prometheus registry. Always present; sample updates are observable via metrics.snapshot(). | packages/server/src/app.ts:291 |
runs | readonly | RunStateTracker | - | packages/server/src/app.ts:260 |
triggers | readonly | | TriggersDaemon | undefined | Optional triggers daemon — populated when the operator wired a scheduler (or an in-process trigger surface) at construction time. Phase 14c integration. | packages/server/src/app.ts:280 |
version | readonly | string | - | packages/server/src/app.ts:255 |
workflows | readonly | WorkflowRegistry | - | packages/server/src/app.ts:259 |
wsDispatcher | readonly | | WsDispatcher | undefined | Optional WebSocket dispatcher exposed when server.ws.enabled = true. Route handlers + the agent / workflow runtimes call dispatcher.emit(subject, event) to fan out events to subscribed clients. Returns undefined when WS is disabled. | packages/server/src/app.ts:268 |
wsTickets | readonly | | WsTicketStore | undefined | Optional WebSocket ticket store exposed when server.ws.enabled = true. Surfaced primarily for tests; the POST /v1/session/ws-ticket route uses it transparently. | packages/server/src/app.ts:274 |
Methods
start()
ts
start(): Promise<{
host: string;
port: number;
}>;Defined in: packages/server/src/app.ts:292
Returns
Promise<{ host: string; port: number; }>
stop()
ts
stop(options?): Promise<void>;Defined in: packages/server/src/app.ts:293
Parameters
| Parameter | Type |
|---|---|
options? | { force?: boolean; } |
options.force? | boolean |
Returns
Promise<void>