Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "index"

Index

Type aliases

LoggerAction

LoggerAction: function

A logger action.

param

The context.

Type declaration

LoggerType

LoggerType: Logger | LoggerAction

A type for a logger.

Predicate

Predicate: function

A predicate.

Type declaration

    • (value: T): Promise<boolean> | boolean
    • Parameters

      • value: T

      Returns Promise<boolean> | boolean

ValueStorage

ValueStorage: object

A value storage.

Type declaration

  • [key: string]: any

WorkflowAction

WorkflowAction: function

A workflow action.

param

The current execution context.

returns

The result.

WorkflowActionResult

WorkflowActionResult: Promise<any> | void

The result of a workflow action.

WorkflowExecutorType

WorkflowExecutorType: WorkflowAction | WorkflowExecutor

Possible types for executing a workflow action.

Variables

DefaultLogLevel

DefaultLogLevel: LogCategory = LogCategory.Notice

The initial value for 'logLevel' property of 'Workflow' class.

DefaultLoggers

DefaultLoggers: LoggerType[]

List of default loggers.

DefaultState

DefaultState: any

The initial value for 'state' property of 'Workflow' class.

EVENTS

EVENTS: EventEmitter = new events.EventEmitter()

Global events.

GLOBALS

GLOBALS: ValueStorage

Stores global values.

Functions

create

  • Creates a new workflow.

    Parameters

    Returns Workflow

    The new workflow.

start

  • Starts a new workflow.

    Parameters

    Returns Promise<any>

    The promise with the result of the workflow.

Generated using TypeDoc