Skip to content

Graphorin API reference v0.15.1


Graphorin API reference / @graphorin/workflow / / WorkflowEvent

Type Alias: WorkflowEvent<TState> ​

ts
type WorkflowEvent<TState> = 
  | WorkflowStartEvent
  | WorkflowStepStartEvent<TState>
  | WorkflowStepEndEvent<TState>
  | WorkflowTaskStartEvent
  | WorkflowTaskEndEvent
  | WorkflowChannelUpdateEvent<TState>
  | WorkflowCheckpointWrittenEvent
  | WorkflowSuspendedEvent<TState>
  | WorkflowResumedEvent<TState>
  | WorkflowEndEvent<TState>
  | WorkflowErrorEvent
  | WorkflowCustomEvent;

Defined in: packages/core/dist/types/workflow-event.d.ts

Stable

Discriminated union of every event produced by Workflow.execute(...) and Workflow.resume(...).

Generic over TState so that downstream consumers can discriminate on the workflow's typed state shape.

Type Parameters ​

Type ParameterDefault type
TStateunknown