Skip to content

Graphorin API reference v0.1.0


Graphorin API reference / @graphorin/server / registry / ServerWorkflowLike

Interface: ServerWorkflowLike

Defined in: packages/server/src/registry/index.ts:39

Minimal shape the server needs from a Workflow. Mirrors the Workflow surface from @graphorin/workflow.

Stable

Properties

PropertyModifierTypeDefined in
namereadonlystringpackages/server/src/registry/index.ts:40

Methods

execute()

ts
execute(input, options?): AsyncIterable<unknown>;

Defined in: packages/server/src/registry/index.ts:41

Parameters

ParameterType
inputunknown
options?{ signal?: AbortSignal; threadId?: string; }
options.signal?AbortSignal
options.threadId?string

Returns

AsyncIterable&lt;unknown&gt;


getState()?

ts
optional getState(threadId): Promise<unknown>;

Defined in: packages/server/src/registry/index.ts:46

Parameters

ParameterType
threadIdstring

Returns

Promise&lt;unknown&gt;


listCheckpoints()?

ts
optional listCheckpoints(threadId): Promise<readonly unknown[]>;

Defined in: packages/server/src/registry/index.ts:47

Parameters

ParameterType
threadIdstring

Returns

Promise&lt;readonly unknown[]&gt;


resume()?

ts
optional resume(threadId, directive?): AsyncIterable<unknown>;

Defined in: packages/server/src/registry/index.ts:45

Parameters

ParameterType
threadIdstring
directive?{ resume?: unknown; }
directive.resume?unknown

Returns

AsyncIterable&lt;unknown&gt;