Skip to content

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

PropertyModifierTypeDescriptionDefined in
agentsreadonlyAgentRegistry-packages/server/src/app.ts:258
appreadonlyHono<{ Variables: ServerVariables; }>-packages/server/src/app.ts:257
configreadonlyServerConfigSpec-packages/server/src/app.ts:256
consolidatorreadonly| ConsolidatorDaemon | undefinedOptional consolidator daemon — populated when the operator supplied a Consolidator instance via createServer({ consolidator }). Phase 14c integration.packages/server/src/app.ts:286
listeningOnreadonly| { host: string; port: number; } | undefined-packages/server/src/app.ts:261
metricsreadonlyMetricRegistryPhase 14c Prometheus registry. Always present; sample updates are observable via metrics.snapshot().packages/server/src/app.ts:291
runsreadonlyRunStateTracker-packages/server/src/app.ts:260
triggersreadonly| TriggersDaemon | undefinedOptional 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
versionreadonlystring-packages/server/src/app.ts:255
workflowsreadonlyWorkflowRegistry-packages/server/src/app.ts:259
wsDispatcherreadonly| WsDispatcher | undefinedOptional 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
wsTicketsreadonly| WsTicketStore | undefinedOptional 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

ParameterType
options?{ force?: boolean; }
options.force?boolean

Returns

Promise&lt;void&gt;