footprintjs - v11.2.0
    Preparing search index...

    Class ResumeEntry<TOut, TScope>

    Type Parameters

    • TOut = any
    • TScope = any
    Index
    start: StageNode<TOut, TScope> | undefined

    Where the resumed TOP-LEVEL traversal starts: the stand-in (a top-level pause) or the mount of the first subflow on the path — each with its dispatcher's continuation attached. undefined for a seed-only entry — the traversal starts at its root.

    startPendingPauses: readonly QueuedPause[] | undefined

    Sibling pauses whose fan-out sits at the TOP level — raised once start's chain ends.

    stepsBeforeStandIn: number | undefined

    How many stage executions the resumed run makes before the stand-in runs — one per subflow on the path, each entered at its mount — so the executor's onResume names the stand-in's own runtimeStageId. undefined when it cannot be known before the run: an outer subflow missing its capture re-runs from its root.

    • The re-entry into subflowId, taken — or undefined when this entry is an ordinary one (the subflow is off the pause path, or its hop was already taken). ONE-SHOT: a hop is returned at most once, so a second entry into the same subflow (a loop passing its mount again) runs the real subflow from its real root with its inputMapper.

      Parameters

      • subflowId: string

      Returns ResumeHop<TOut, TScope> | undefined

    • A seed-only entry: each capture seeds the FIRST entry into its subflow, which then starts at its own root. Pass it explicitly as resume to TraverserOptions or HandlerDeps — the same one-shot law, without a stand-in or a path. Prefer plan when resuming a checkpoint.

      Type Parameters

      • TOut
      • TScope

      Parameters

      • captures: Record<string, Record<string, unknown>>

      Returns ResumeEntry<TOut, TScope>

    • Plan the re-entry of a paused chart. Every mount on the path, every dispatcher continuation and every waiting sibling is resolved HERE, against the chart as built, before a single stage runs — so a checkpoint whose path the chart cannot walk is refused up front instead of resuming into the wrong shape.

      Type Parameters

      • TOut
      • TScope

      Parameters

      • args: {
            captures: Record<string, Record<string, unknown>> | undefined;
            path: readonly string[];
            pendingPauses?: readonly PendingPause[];
            root: StageNode<TOut, TScope>;
            standIn: StageNode<TOut, TScope>;
            subflows: Record<string, { root: StageNode<TOut, TScope> }> | undefined;
        }

        root and subflows: the chart as built (FlowChart.root, FlowChart.subflows); path: checkpoint.subflowPath, outermost first; captures: checkpoint.subflowStates (a detached copy); standIn: the node that runs the resume half — the paused stage's own node, function swapped (its continuation is attached here); pendingPauses: checkpoint.pendingPauses (a detached copy).

      Returns ResumeEntry<TOut, TScope>

      when a subflow on the path is missing, mounted more than once, or its mount cannot be reached from the enclosing graph; or when a pending pause is malformed or is not a parallel sibling of the paused stage