Skip to content

Graphorin API reference v0.12.1


Graphorin API reference / @graphorin/workflow / / WorkflowChannelUpdateEvent

Interface: WorkflowChannelUpdateEvent<TState>

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

Stable

Type Parameters

Type ParameterDefault type
TStateunknown

Properties

PropertyModifierTypeDescriptionDefined in
channelreadonlykeyof TState & string-packages/core/dist/types/workflow-event.d.ts
stepNumberreadonlynumber-packages/core/dist/types/workflow-event.d.ts
typereadonly"workflow.channel.update"-packages/core/dist/types/workflow-event.d.ts
value?readonlyunknownThe merged value, carried ONLY for ephemeral channels (workflow-07): their values are wiped from state before the next planning round, so this event is the one place a consumer can observe them. Persistent channels omit it - read the state instead.packages/core/dist/types/workflow-event.d.ts
versionreadonlynumber-packages/core/dist/types/workflow-event.d.ts