tuil
ReferencePackages@mwillbanks/tuil-workflowAPI

WorkflowContext

interface exported by @mwillbanks/tuil-workflow.

View rawEdit

interface

Public interface exported by @mwillbanks/tuil-workflow.

export interface WorkflowContext<TState> {
  readonly state: TState;
  readonly signal: AbortSignal;
  readonly runner: WorkflowRunner<TState>;
}

Members

MemberTypeRequiredDescriptionRelated types
stateTStateYesThe state member uses the TState contract.
signalAbortSignalYesThe signal member uses the AbortSignal contract.
runnerWorkflowRunner<TState>YesThe runner member uses the WorkflowRunner<TState> contract.WorkflowRunner

Parameters

This declaration has no public members.

Returns

This declaration does not return a value.

Throws

No thrown errors are documented for this declaration.

Source

View the secondary source reference

Package

@mwillbanks/tuil-workflow

On this page