Interface IStepsController

Hierarchy

IErrorController
- IStepsController

Implemented by

StepsController

Index

Properties

Methods

abort begin declare emit fail step stop succeed update

Properties

`Readonly` state

state: State

Methods

abort

abort(options): Process<void, Control.Events.Abort | Control.Events.Stop>
Parameters
- options: Control.Controllers.Error.Options.Abort
Returns Process<void, Control.Events.Abort | Control.Events.Stop>
Inherited from IErrorController.abort
- Defined in control/controllers/ErrorController.ts:31

begin

begin(options?): Process<void, Control.Events.Begin>
Parameters
- Optional options: Control.Controllers.Steps.Options.Begin
Returns Process<void, Control.Events.Begin>
- Defined in control/controllers/StepsController.ts:42

declare

declare(options): Process<IValueResolutionController, Control.Events.Declare>
Parameters
- options: Control.Controllers.Steps.Options.Declare
Returns Process<IValueResolutionController, Control.Events.Declare>
- Defined in control/controllers/StepsController.ts:45

emit

emit<E>(event): E
Type Parameters
- E extends Event
Parameters
- event: Omit<E, "scope">
Returns E
Inherited from IErrorController.emit
- Defined in control/controllers/BaseController.ts:12

fail

fail(options): Process<void, Control.Events.Fail | Control.Events.Abort | Control.Events.Stop>
Parameters
- options: Control.Controllers.Error.Options.Fail
Returns Process<void, Control.Events.Fail | Control.Events.Abort | Control.Events.Stop>
Inherited from IErrorController.fail
- Defined in control/controllers/ErrorController.ts:28

step

step(options): Process<IStepsController, Control.Events.Step>
Parameters
- options: Control.Controllers.Steps.Options.Step
Returns Process<IStepsController, Control.Events.Step>
- Defined in control/controllers/StepsController.ts:48

stop

stop(options?): Process<void, Control.Events.Stop>
Parameters
- Optional options: Control.Controllers.Error.Options.Stop
Returns Process<void, Control.Events.Stop>
Inherited from IErrorController.stop
- Defined in control/controllers/ErrorController.ts:32

succeed

succeed(options?): Process<void, Control.Events.Succeed>
Parameters
- Optional options: Control.Controllers.Steps.Options.Succeed
Returns Process<void, Control.Events.Succeed>
- Defined in control/controllers/StepsController.ts:44

update

update(options): Process<void, Control.Events.Update>
Parameters
- options: Control.Controllers.Steps.Options.Update
Returns Process<void, Control.Events.Update>
- Defined in control/controllers/StepsController.ts:43

Generated using TypeDoc