Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Workflow

A workflow.

Hierarchy

  • EventEmitter
    • Workflow

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Initializes a new instance of that class.

    Returns Workflow

Properties

Protected _actionStates

_actionStates: any[] = []

Stores the permanent state values of the actions.

Protected _actions

_actions: WorkflowActionEntry[] = []

Stores the actions of the Workflow.

Protected _executions

_executions: number = 0

Stores the number of workflow execution.

Protected _logLevel

_logLevel: LogCategory = DefaultLogLevel

Stores the minimal log level.

Protected _loggers

_loggers: LoggerEntry[] = []

Stores the loggers.

Protected _state

_state: any = DefaultState

Stores the current state value.

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

executions

  • get executions(): number

  • Gets the number of workflow executions.

    Returns number

logLevel

  • Gets or sets the minimal log level.

    Returns LogCategory

  • Gets or sets the minimal log level.

    Parameters

    Returns void

state

  • get state(): any
  • set state(newValue: any): void

  • Gets or sets state of that workflow.

    Returns any

  • Gets or sets state of that workflow.

    Parameters

    • newValue: any

    Returns void

Methods

addListener

  • addListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

addLogger

  • addLogger(logger?: LoggerType, thisArg?: any): this

  • Adds a logger.

    chainable

    Parameters

    • Optional logger: LoggerType
    • Optional thisArg: any

    Returns this

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

next

  • Alias for 'then'.

    Parameters

    Returns this

Protected notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string, oldValue: any, newValue: any): this

  • Notifies for a property change.

    chainable

    Parameters

    • propertyName: string

      The name of the property.

    • oldValue: any

      The old value.

    • newValue: any

      The new value.

    Returns this

on

  • on(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

once

  • once(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

reset

  • reset(): this

  • Resets the workflow.

    chainable

    Returns this

resetActionStates

  • resetActionStates(): this

  • Resets the state values of the actions.

    chainable

    Returns this

resetLoggers

  • resetLoggers(): this

  • Resets the loggers.

    chainable

    Returns this

resetState

  • resetState(): this

  • Resets the state value.

    chainable

    Returns this

setLogLevel

  • Sets the minimal log level.

    chainable

    Parameters

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

setState

  • setState(newValue: any): this

  • Sets the state value.

    chainable

    Parameters

    • newValue: any

      The new value.

    Returns this

start

  • start(initialValue?: any): Promise<any>

  • Starts the workflow.

    Parameters

    • Optional initialValue: any

    Returns Promise<any>

    The promise with the result of the workflow.

then

  • Adds a new action.

    chainable

    Parameters

    Returns this

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc