Interface SerialPlan

Represents an execution plan that defines the steps and operations for initializing, mutating, or restoring a template's state.

interface SerialPlan {
    data?: any;
    didUpdate: boolean[];
    forkId: string;
    forkStack: Fork[];
    lastCompletedStep?: PlanStep;
    op?: Op;
    output: object;
    restoreJsonPtrs: string[];
    sortedJsonPtrs: string[];
    type?: "serial|parallel";
}

Hierarchy (view full)

Properties

data? didUpdate forkId forkStack lastCompletedStep? op? output restoreJsonPtrs sortedJsonPtrs type?

Properties

Optional data

data?: any

The data associated with the plan. May be undefined for initialization plans.

didUpdate

didUpdate: boolean[]

forkId

forkId: string

The identifier for the fork associated with this execution plan. Will be "ROOT" when the plan is not executing a fork

forkStack

forkStack: Fork[]

The stack of forks involved in this execution plan. Forks will push and pop on top of the ROOT fork corresponding to entering a $forked() and exiting a forked plan on $joined()

Optional lastCompletedStep

lastCompletedStep?: PlanStep

The last completed step in the execution plan, if any.

Optional op

op?: Op

The operation to perform. If present and op is "set", the data is applied to the first JSON pointer.

output

output: object

The output object associated with the execution plan.

restoreJsonPtrs

restoreJsonPtrs: string[]

sortedJsonPtrs

sortedJsonPtrs: string[]

Optional type

type?: "serial|parallel"

Plans can be serialized and stored therefor we need to know what type of ExecutionPlan this is. Defaults to "serial" if not present. Allowed values "serial|parallel"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc