Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WorkflowActionContext

An execution context of a workflow action.

Hierarchy

  • WorkflowActionContext

Index

Properties

Properties

alert

alert: function

Logs an alert message.

param

The message (value).

param

The tag.

param

The priority.

chainable

Type declaration

    • (msg: any, tag?: string, priority?: number): this

    • Parameters

      • msg: any
      • Optional tag: string
      • Optional priority: number

      Returns this

count

count: number

Gets the number of all workflow actions.

crit

crit: function

Logs a critical message.

param

The message (value).

param

The tag.

param

The priority.

chainable

Type declaration

    • (msg: any, tag?: string, priority?: number): this

    • Parameters

      • msg: any
      • Optional tag: string
      • Optional priority: number

      Returns this

current

current: WorkflowActionContext

Gets the context of the current executing action.

dbg

dbg: function

Logs a debug message.

param

The message (value).

param

The tag.

param

The priority.

chainable

Type declaration

    • (msg: any, tag?: string, priority?: number): this

    • Parameters

      • msg: any
      • Optional tag: string
      • Optional priority: number

      Returns this

emerg

emerg: function

Logs an emergency message.

param

The message (value).

param

The tag.

param

The priority.

chainable

Type declaration

    • (msg: any, tag?: string, priority?: number): this

    • Parameters

      • msg: any
      • Optional tag: string
      • Optional priority: number

      Returns this

err

err: function

Logs an error message.

param

The message (value).

param

The tag.

param

The priority.

chainable

Type declaration

    • (msg: any, tag?: string, priority?: number): this

    • Parameters

      • msg: any
      • Optional tag: string
      • Optional priority: number

      Returns this

events

events: EventEmitter

Gets the (global) events for all actions.

executions

executions: number

Gets the current number of executed actions.

finish

finish: function

Skips all upcoming actions.

chainable

Type declaration

    • (): this

    • Returns this

globalEvents

globalEvents: EventEmitter

Accesses the global event emitter.

globals

globals: ValueStorage

Gets the global value storage.

goBack

goBack: function

Goes back a number of actions.

param

The number of actions to go back. Default: 1

chainable

Type declaration

    • (cnt?: number): void

    • Parameters

      • Optional cnt: number

      Returns void

goto

goto: function

Sets the pointer for the next action.

param

The zero based index of the next action.

chainable

Type declaration

    • (newIndex: number): this

    • Parameters

      • newIndex: number

      Returns this

gotoFirst

gotoFirst: function

Sets the pointer to the first action.

chainable

Type declaration

    • (): this

    • Returns this

gotoLast

gotoLast: function

Sets the pointer to the last action.

chainable

Type declaration

    • (): this

    • Returns this

gotoNext

gotoNext: function

Sets the pointer to the next action.

chainable

Type declaration

    • (): this

    • Returns this

index

index: number

Gets the current zero based index.

info

info: function

Logs an info message.

param

The message (value).

param

The tag.

param

The priority.

chainable

Type declaration

    • (msg: any, tag?: string, priority?: number): this

    • Parameters

      • msg: any
      • Optional tag: string
      • Optional priority: number

      Returns this

isBetween

isBetween: boolean

Gets if the current action is NOT the first AND NOT the last one.

isFirst

isFirst: boolean

Gets if the current action is the FIRST one.

isLast

isLast: boolean

Gets if the current action is the LAST one.

log

log: function

Logs a message.

param

The message (value).

param

The tag.

param

The category.

param

The priority.

chainable

Type declaration

    • (msg: any, tag?: string, category?: LogCategory, priority?: number): this

    • Parameters

      • msg: any
      • Optional tag: string
      • Optional category: LogCategory
      • Optional priority: number

      Returns this

Optional nextValue

nextValue: any

Gets or sets the value for the next execution.

note

note: function

Logs a notice.

param

The message (value).

param

The tag.

param

The priority.

chainable

Type declaration

    • (msg: any, tag?: string, priority?: number): this

    • Parameters

      • msg: any
      • Optional tag: string
      • Optional priority: number

      Returns this

permanentGlobals

permanentGlobals: ValueStorage

Access the value for permanent, global values.

permanentState

permanentState: any

Gets or sets the (permanent) state value for the underlying action.

Optional previousEndTime

previousEndTime: Date

Gets the end time of the previous action.

Optional previousIndex

previousIndex: number

Gets the index of the previous workflow.

Optional previousStartTime

previousStartTime: Date

Gets the start time of the previous action.

Optional previousValue

previousValue: any

Gets the value from the previous execution.

repeat

repeat: function

Marks the action to be repeated next time.

Type declaration

    • (): this

    • Returns this

result

result: any

Gets or sets the result of the whole workflow.

skip

skip: function

Skips a number of upcoming actions.

param

The number of actions to skip. Default: 1

chainable

Type declaration

    • (cnt?: number): this

    • Parameters

      • Optional cnt: number

      Returns this

skipWhile

skipWhile: Predicate<WorkflowActionContext>

Skips the upcoming actions based on a predicate.

startTime

startTime: Date

Gets the start time of the workflow.

state

state: any

Gets or sets the state value for the underlying action.

time

time: Date

Gets the time the action has been started.

trace

trace: function

Logs a trace message.

param

The message (value).

param

The tag.

param

The priority.

chainable

Type declaration

    • (msg: any, tag?: string, priority?: number): this

    • Parameters

      • msg: any
      • Optional tag: string
      • Optional priority: number

      Returns this

value

value: any

Gets or sets a value for the whole execution chain.

warn

warn: function

Logs a warning message.

param

The message (value).

param

The tag.

param

The priority.

chainable

Type declaration

    • (msg: any, tag?: string, priority?: number): this

    • Parameters

      • msg: any
      • Optional tag: string
      • Optional priority: number

      Returns this

workflowEvents

workflowEvents: EventEmitter

Accesses the event emitter of the underlying workflow.

workflowExecutions

workflowExecutions: number

Gets the number of workflow executions.

workflowState

workflowState: any

Gets or sets the state of the underlying workflow.

Generated using TypeDoc