Class StepsController

Hierarchy

ErrorController
- StepsController

Implements

IStepsController

Index

Constructors

constructor

Properties

Accessors

state

Methods

Constructors

constructor

new StepsController(options: ConstructorOptions): StepsController

Inherited from ErrorController.constructor
- Defined in preserve/lib/control/controllers/StepsController.ts:53
Parameters
- options: ConstructorOptions
Returns StepsController

Properties

Protected _state

_state: State

Protected children

children: IErrorController[]

Protected Optional parent

parent: IErrorController

Protected scope

scope: Scope

Accessors

state

get state(): State

Implementation of IStepsController.state
- Defined in preserve/lib/control/controllers/BaseController.ts:19
Returns State

Methods

abort

abort(__namedParameters?: Abort): AsyncGenerator<Stop | Abort, void, void>

Implementation of IStepsController.abort

Inherited from ErrorController.abort
- Defined in preserve/lib/control/controllers/ErrorController.ts:78
Parameters
- __namedParameters: Abort = ...
Returns AsyncGenerator<Stop | Abort, void, void>

begin

begin(): AsyncGenerator<Begin, void, unknown>

- Defined in preserve/lib/control/controllers/StepsController.ts:68
Returns AsyncGenerator<Begin, void, unknown>

declare

declare(__namedParameters: Declare): AsyncGenerator<Declare, ValueResolutionController, unknown>

Implementation of IStepsController.declare
- Defined in preserve/lib/control/controllers/StepsController.ts:93
Parameters
- __namedParameters: Declare
Returns AsyncGenerator<Declare, ValueResolutionController, unknown>

emit

emit<E>(event: Pick<E, Exclude<keyof E, "scope">>): E

Implementation of IStepsController.emit

Inherited from ErrorController.emit
- Defined in preserve/lib/control/controllers/BaseController.ts:30
Type parameters
- E: Event
Parameters
- event: Pick<E, Exclude<keyof E, "scope">>
Returns E

fail

fail(__namedParameters?: Fail): AsyncGenerator<Stop | Fail | Abort, void, void>

Implementation of IStepsController.fail

Inherited from ErrorController.fail
- Defined in preserve/lib/control/controllers/ErrorController.ts:58
Parameters
- __namedParameters: Fail = ...
Returns AsyncGenerator<Stop | Fail | Abort, void, void>

step

step(__namedParameters: Step): AsyncGenerator<Step, StepsController, unknown>

Implementation of IStepsController.step
- Defined in preserve/lib/control/controllers/StepsController.ts:113
Parameters
- __namedParameters: Step
Returns AsyncGenerator<Step, StepsController, unknown>

stop

stop(__namedParameters?: Stop): AsyncGenerator<Stop, void, void>

Implementation of IStepsController.stop

Inherited from ErrorController.stop
- Defined in preserve/lib/control/controllers/ErrorController.ts:98
Parameters
- __namedParameters: Stop = ...
Returns AsyncGenerator<Stop, void, void>

succeed

succeed(__namedParameters?: Succeed): AsyncGenerator<Succeed, void, unknown>

Implementation of IStepsController.succeed
- Defined in preserve/lib/control/controllers/StepsController.ts:76
Parameters
- __namedParameters: Succeed = ...
Returns AsyncGenerator<Succeed, void, unknown>

update

update(__namedParameters: Update): AsyncGenerator<Update, void, unknown>

Implementation of IStepsController.update
- Defined in preserve/lib/control/controllers/StepsController.ts:85
Parameters
- __namedParameters: Update
Returns AsyncGenerator<Update, void, unknown>

Generated using TypeDoc