Graphorin API reference v0.1.0

---

Graphorin API reference / @graphorin/workflow / / Workflow

Interface: Workflow<TState, TInput>

Defined in: packages/workflow/src/types.ts:303

Top-level handle returned by createWorkflow.

Stable

Type Parameters

Type Parameter	Default type
TState extends object	Record<string, unknown>
TInput	Partial<TState>

Properties

Property	Modifier	Type	Defined in
name	readonly	string	packages/workflow/src/types.ts:307
nodeNames	readonly	readonly string[]	packages/workflow/src/types.ts:308

Methods

execute()

execute(input, opts?): AsyncIterable<WorkflowEvent<TState>>;

Defined in: packages/workflow/src/types.ts:309

Parameters

Parameter	Type
input	TInput
opts?	WorkflowExecuteOptions

Returns

AsyncIterable<WorkflowEvent&lt;TState&gt;>

---

fork()

fork(threadId, fromCheckpointId): Promise<{
  newThreadId: string;
}>;

Defined in: packages/workflow/src/types.ts:317

Parameters

Parameter	Type
threadId	string
fromCheckpointId	string

Returns

Promise<{ newThreadId: string; }>

---

getState()

getState(threadId): Promise<WorkflowState<TState>>;

Defined in: packages/workflow/src/types.ts:315

Parameters

Parameter	Type
threadId	string

Returns

Promise<WorkflowState&lt;TState&gt;>

---

listCheckpoints()

listCheckpoints(threadId): Promise<readonly Checkpoint[]>;

Defined in: packages/workflow/src/types.ts:316

Parameters

Parameter	Type
threadId	string

Returns

Promise&lt;readonly Checkpoint[]&gt;

---

resume()

resume(
   threadId, 
   directive?, 
opts?): AsyncIterable<WorkflowEvent<TState>>;

Defined in: packages/workflow/src/types.ts:310

Parameters

Parameter	Type
threadId	string
directive?	Directive<Record&lt;string, unknown&gt;, unknown>
opts?	WorkflowResumeOptions

Returns

AsyncIterable<WorkflowEvent&lt;TState&gt;>