WorkflowEvent
interface exported by @mwillbanks/tuil-workflow.
interface
Public interface exported by @mwillbanks/tuil-workflow.
export interface WorkflowEvent<TState> {
readonly type: WorkflowEventType;
readonly snapshot: WorkflowSnapshot<TState>;
readonly step?: string;
readonly error?: unknown;
readonly at: number;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
type | WorkflowEventType | Yes | The type member uses the WorkflowEventType contract. | WorkflowEventType |
snapshot | WorkflowSnapshot<TState> | Yes | The snapshot member uses the WorkflowSnapshot<TState> contract. | WorkflowSnapshot |
step | string | undefined | No | The step member uses the string | undefined contract. | — |
error | unknown | No | The error member uses the unknown contract. | — |
at | number | Yes | The at member uses the number contract. | — |
Parameters
This declaration has no public members.
Returns
This declaration does not return a value.
Throws
No thrown errors are documented for this declaration.
Related types
Source
View the secondary source reference