transition
function exported by @mwillbanks/tuil-workflow.
function
Public function exported by @mwillbanks/tuil-workflow.
export function transition<TState>(
from: string,
to: string,
options: Pick<WorkflowTransition<TState>, "when"> = {},
): WorkflowTransition<TState>;Members
This declaration has no public members.
Parameters
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
from | string | Yes | Supplies the from value as string. | — |
to | string | Yes | Supplies the to value as string. | — |
options | Pick<WorkflowTransition<TState>, "when"> | No | Supplies the options value as Pick<WorkflowTransition<TState>, "when">. | WorkflowTransition |
Returns
WorkflowTransition<TState> — Returns a value that satisfies WorkflowTransition<TState>.
Related types: WorkflowTransition
Throws
No thrown errors are documented for this declaration.
Related types
Source
View the secondary source reference