WorkflowPersistence
interface exported by @mwillbanks/tuil-workflow.
interface
Public interface exported by @mwillbanks/tuil-workflow.
export interface WorkflowPersistence<TState> {
readonly load: (
id: string,
signal: AbortSignal,
) =>
| PersistedWorkflow<TState>
| undefined
| Promise<PersistedWorkflow<TState> | undefined>;
readonly save: (
id: string,
value: PersistedWorkflow<TState>,
signal: AbortSignal,
) => void | Promise<void>;
readonly remove?: (id: string, signal: AbortSignal) => void | Promise<void>;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
load | (id: string, signal: AbortSignal) => PersistedWorkflow<TState> | undefined | Promise<PersistedWorkflow<TState> | undefined> | Yes | The load member uses the (id: string, signal: AbortSignal) => PersistedWorkflow<TState> | undefined | Promise<PersistedWorkflow<TState> | undefined> contract. | PersistedWorkflow |
save | (id: string, value: PersistedWorkflow<TState>, signal: AbortSignal) => void | Promise<void> | Yes | The save member uses the (id: string, value: PersistedWorkflow<TState>, signal: AbortSignal) => void | Promise<void> contract. | PersistedWorkflow |
remove | ((id: string, signal: AbortSignal) => void | Promise<void>) | undefined | No | The remove member uses the ((id: string, signal: AbortSignal) => void | Promise<void>) | undefined 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