Namespace Control

Index

Namespaces

Enumerations

State

Classes

Interfaces

Type aliases

Functions

control
run

Type aliases

Controls

Controls: Pick<StepsController, "update" | "declare" | "step">

EventName

EventName: "fail" | "abort" | "stop" | "begin" | "succeed" | "step" | "declare" | "resolve" | "update"

Process

Process<R, E>: AsyncGenerator<E, R, void>

Type parameters

R: any
E: Event

Scope

Scope: string[]

Functions

control

control<R, O>(controlOptions: ControlOptions<R, O>, methodOptions: Omit<O, "controls">): Process<R>

- Defined in preserve/lib/control/control.ts:9
Type parameters
- R
- O: HasControls
Parameters
- controlOptions: ControlOptions<R, O>
- methodOptions: Omit<O, "controls">
Returns Process<R>

Const run

run<R, O>(controlOptions: ControlOptions<R, O>, methodOptions: Pick<O, Exclude<keyof O, "controls">>): Promise<R>

- Defined in preserve/lib/control/control.ts:46
Type parameters
- R
- O: HasControls
Parameters
- controlOptions: ControlOptions<R, O>
- methodOptions: Pick<O, Exclude<keyof O, "controls">>
Returns Promise<R>

Generated using TypeDoc