Class WorkflowController<T>

Type parameters

T

Hierarchy

WorkflowController

Index

Constructors

constructor

Properties

workflow

Accessors

payload

Methods

Constructors

constructor

new WorkflowController(workflow: WorkflowModel<any>): WorkflowController

- Defined in WorkflowController.ts:9
Parameters
- workflow: WorkflowModel<any>
Returns WorkflowController

Properties

Private workflow

workflow: WorkflowModel<T>

Accessors

payload

get payload(): T
set payload(value: T): void

- Defined in WorkflowController.ts:20
Returns T
- Defined in WorkflowController.ts:24
Parameters
- value: T
Returns void

Methods

add

add(stepName: string, payload: any, prevoiusItem?: WorkflowStepModel): WorkflowStepModel

- Defined in WorkflowController.ts:37
Parameters
- stepName: string
- payload: any
- Optional prevoiusItem: WorkflowStepModel
Returns WorkflowStepModel

addStep

addStep(item: WorkflowStepModel, prevoiusItem?: WorkflowStepModel): void

- Defined in WorkflowController.ts:32
Parameters
- item: WorkflowStepModel
- Optional prevoiusItem: WorkflowStepModel
Returns void

getCurrentPayload

getCurrentPayload<TPayload>(): TPayload

- Defined in WorkflowController.ts:49
Type parameters
- TPayload
Returns TPayload

getCurrentStep

getCurrentStep(): WorkflowStepModel

- Defined in WorkflowController.ts:45
Returns WorkflowStepModel

getCurrentStepName

getCurrentStepName(): string

- Defined in WorkflowController.ts:28
Returns string

getNextStep

getNextStep(state?: WorkflowState): WorkflowStepModel

- Defined in WorkflowController.ts:78
Parameters
- Default value state: WorkflowState = WorkflowState.Unknown
Returns WorkflowStepModel

getNextStepWithState

getNextStepWithState(state?: WorkflowState): WorkflowStepModel

- Defined in WorkflowController.ts:63
Parameters
- Default value state: WorkflowState = WorkflowState.Unknown
Returns WorkflowStepModel

getNextWithState

getNextWithState(state?: WorkflowState): [WorkflowStepModel, number]

- Defined in WorkflowController.ts:169
Parameters
- Default value state: WorkflowState = WorkflowState.Unknown
Returns [WorkflowStepModel, number]

getPreviousStep

getPreviousStep(currentStep: WorkflowStepModel, state?: WorkflowState): WorkflowStepModel

- Defined in WorkflowController.ts:119
Parameters
- currentStep: WorkflowStepModel
- Default value state: WorkflowState = WorkflowState.Done
Returns WorkflowStepModel

getWorkflow

getWorkflow(): WorkflowModel<T>

- Defined in WorkflowController.ts:16
Returns WorkflowModel<T>

getWorkflowState

getWorkflowState(): WorkflowState

- Defined in WorkflowController.ts:191
Returns WorkflowState

peekNextStep

peekNextStep(state?: WorkflowState): [WorkflowStepModel, number]

- Defined in WorkflowController.ts:73
Parameters
- Optional state: WorkflowState
Returns [WorkflowStepModel, number]

peekPreviousStep

peekPreviousStep(currentStep: WorkflowStepModel, state?: WorkflowState): [WorkflowStepModel, number]

- Defined in WorkflowController.ts:93
Parameters
- currentStep: WorkflowStepModel
- Default value state: WorkflowState = WorkflowState.Done
Returns [WorkflowStepModel, number]

setCurrentPayload

setCurrentPayload(key: string, value: any): void

- Defined in WorkflowController.ts:54
Parameters
- key: string
- value: any
Returns void

skipToStep

skipToStep(workflowName: string): WorkflowStepModel

- Defined in WorkflowController.ts:130
Parameters
- workflowName: string
Returns WorkflowStepModel

Generated using TypeDoc