Interface ActionContext

Low level action context.

interface ActionContext {
    actionName: string;
    args: readonly any[];
    asyncStepType?: ActionContextAsyncStepType;
    data: Record<symbol, any>;
    parentContext?: ActionContext;
    previousAsyncStepContext?: ActionContext;
    rootContext: ActionContext;
    spawnAsyncStepContext?: ActionContext;
    target: object;
    type: ActionContextActionType;
}

Properties

actionName args asyncStepType? data parentContext? previousAsyncStepContext? rootContext spawnAsyncStepContext? target type

Properties

Readonly actionName

actionName: string

Action name

Readonly args

args: readonly any[]

Array of action arguments.

Optional Readonly asyncStepType

asyncStepType?: ActionContextAsyncStepType

Async step type, or undefined for sync actions.

Readonly data

data: Record<symbol, any>

Custom data for the action context to be set by middlewares, an object. Symbols must be used as keys to avoid name clashing between middlewares.

Optional Readonly parentContext

parentContext?: ActionContext

Parent action context, if any.

Optional Readonly previousAsyncStepContext

previousAsyncStepContext?: ActionContext

Previous async step context, undefined for sync actions or the first action of a flow.

Readonly rootContext

rootContext: ActionContext

Root action context, or itself if the root.

Optional Readonly spawnAsyncStepContext

spawnAsyncStepContext?: ActionContext

Spawn async step context, undefined for sync actions.

Readonly target

target: object

Action target object.

Readonly type

type: ActionContextActionType

Action type, sync or async.

Settings

Member Visibility

Theme

On This Page

actionNameargsasyncStepTypedataparentContextpreviousAsyncStepContextrootContextspawnAsyncStepContexttargettype