WorkflowParallelBranch
interface exported by @mwillbanks/tuil-workflow.
interface
Public interface exported by @mwillbanks/tuil-workflow.
export interface WorkflowParallelBranch<TState> {
readonly id: string;
readonly run: (
context: WorkflowContext<TState>,
) => unknown | Promise<unknown>;
readonly compensate?: (
context: WorkflowContext<TState>,
) => void | Promise<void>;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
id | string | Yes | The id member uses the string contract. | — |
run | (context: WorkflowContext<TState>) => unknown | Promise<unknown> | Yes | The run member uses the (context: WorkflowContext<TState>) => unknown | Promise<unknown> contract. | WorkflowContext |
compensate | ((context: WorkflowContext<TState>) => void | Promise<void>) | undefined | No | The compensate member uses the ((context: WorkflowContext<TState>) => void | Promise<void>) | undefined contract. | WorkflowContext |
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