Class StepsController

Hierarchy

ErrorController
- StepsController

Implements

IStepsController

Index

Constructors

Properties

_state children parent? scope

Accessors

Methods

abort begin declare emit fail step stop succeed update

Constructors

constructor

new StepsController(options): StepsController
Parameters
- options: Control.Controllers.Steps.ConstructorOptions
Returns StepsController
Overrides ErrorController.constructor
- Defined in control/controllers/StepsController.ts:54

Properties

`Protected` _state

_state: State

`Protected` children

children: IErrorController[]

`Protected` `Optional` parent

parent?: IErrorController

`Protected` scope

scope: Scope

Accessors

state

get state(): State
Returns State
Implementation of IStepsController.state

Inherited from ErrorController.state
- Defined in control/controllers/BaseController.ts:19

Methods

abort

abort(__namedParameters?): AsyncGenerator<Control.Events.Abort | Control.Events.Stop, void, void>
Parameters
- __namedParameters: Control.Controllers.Error.Options.Abort = {}
Returns AsyncGenerator<Control.Events.Abort | Control.Events.Stop, void, void>
Implementation of IStepsController.abort

Inherited from ErrorController.abort
- Defined in control/controllers/ErrorController.ts:77

begin

begin(): AsyncGenerator<Control.Events.Begin, void, unknown>
Returns AsyncGenerator<Control.Events.Begin, void, unknown>
Implementation of IStepsController.begin
- Defined in control/controllers/StepsController.ts:66

declare

declare(__namedParameters): AsyncGenerator<Control.Events.Declare, ValueResolutionController, unknown>
Parameters
- __namedParameters: Control.Controllers.Steps.Options.Declare
Returns AsyncGenerator<Control.Events.Declare, ValueResolutionController, unknown>
Implementation of IStepsController.declare
- Defined in control/controllers/StepsController.ts:92

emit

emit<E>(event): E
Type Parameters
- E extends Event
Parameters
- event: Omit<E, "scope">
Returns E
Implementation of IStepsController.emit

Inherited from ErrorController.emit
- Defined in control/controllers/BaseController.ts:30

fail

fail(__namedParameters?): AsyncGenerator<Control.Events.Fail | Control.Events.Abort | Control.Events.Stop, void, void>
Parameters
- __namedParameters: Control.Controllers.Error.Options.Fail = {}
Returns AsyncGenerator<Control.Events.Fail | Control.Events.Abort | Control.Events.Stop, void, void>
Implementation of IStepsController.fail

Inherited from ErrorController.fail
- Defined in control/controllers/ErrorController.ts:57

step

step(__namedParameters): AsyncGenerator<Control.Events.Step, StepsController, unknown>
Parameters
- __namedParameters: Control.Controllers.Steps.Options.Step
Returns AsyncGenerator<Control.Events.Step, StepsController, unknown>
Implementation of IStepsController.step
- Defined in control/controllers/StepsController.ts:112

stop

stop(__namedParameters?): AsyncGenerator<Control.Events.Stop, void, void>
Parameters
- __namedParameters: Control.Controllers.Error.Options.Stop = {}
Returns AsyncGenerator<Control.Events.Stop, void, void>
Implementation of IStepsController.stop

Inherited from ErrorController.stop
- Defined in control/controllers/ErrorController.ts:96

succeed

succeed(__namedParameters?): AsyncGenerator<Control.Events.Succeed, void, unknown>
Parameters
- __namedParameters: Control.Controllers.Steps.Options.Succeed = {}
Returns AsyncGenerator<Control.Events.Succeed, void, unknown>
Implementation of IStepsController.succeed
- Defined in control/controllers/StepsController.ts:74

update

update(__namedParameters): AsyncGenerator<Control.Events.Update, void, unknown>
Parameters
- __namedParameters: Control.Controllers.Steps.Options.Update
Returns AsyncGenerator<Control.Events.Update, void, unknown>
Implementation of IStepsController.update
- Defined in control/controllers/StepsController.ts:84

Generated using TypeDoc