footprintjs - v11.2.0
    Preparing search index...

    Interface InOutEntry

    One half of a chart execution boundary. Entry/exit pairs share runtimeStageId.

    Naming follows the engine: subflowId is the path-prefixed identifier the engine emits (e.g. 'sf-outer/sf-inner' for nested subflows). For the top-level run, it's the synthetic '__root__'. subflowPath is the decomposition into segments — provided as a convenience because consumers often query / group by the path tree.

    interface InOutEntry {
        attempts?: InOutAttempts;
        depth: number;
        description?: string;
        failedAttempts?: readonly AttemptRef[];
        isRoot: boolean;
        localSubflowId: string;
        payload?: unknown;
        phase: InOutPhase;
        runtimeStageId: string;
        subflowId: string;
        subflowName: string;
        subflowPath: readonly string[];
    }
    Index
    attempts? depth description? failedAttempts? isRoot localSubflowId payload? phase runtimeStageId subflowId subflowName subflowPath
    attempts?: InOutAttempts

    phase: 'exit' only, and only when something inside retried, gave up or timed out — see InOutAttempts.

    depth: number

    Depth in the subflow tree. Root → 0. First-level subflow → 1.

    description?: string

    Build-time description from the subflow's root stage. Carries taxonomy markers (e.g. 'Agent: ReAct loop'). Undefined for root.

    failedAttempts?: readonly AttemptRef[]

    With attempts: the attempts inside that failed, timed out or were aborted, in the order they ended.

    isRoot: boolean

    True when this entry came from the top-level run (onRunStart / onRunEnd) rather than from a subflow (onSubflowEntry / onSubflowExit). Lens uses this to render the root pair as user → run → user instead of the regular subflow shape.

    localSubflowId: string

    Last segment of subflowId — convenience for consumers that group by leaf name. Top-level → '__root__'.

    payload?: unknown

    Data crossing the boundary.

    • phase: 'entry' → inputMapper result (subflow) or run({input}) (root)
    • phase: 'exit' → subflow shared state at exit (subflow) or chart return value (root)

    Undefined when no mapper / no input was provided.

    phase: InOutPhase

    Which side of the boundary this entry represents.

    runtimeStageId: string

    runtimeStageId — same value for the entry/exit pair of one execution. Top-level run uses the synthetic ROOT_RUNTIME_STAGE_ID.

    subflowId: string

    Path-prefixed subflow identifier (matches the engine's FlowSubflowEvent.subflowId). Top-level → '__root__'. Subflow → 'sf-outer' or 'sf-outer/sf-inner'.

    subflowName: string

    Human-readable display name (from the builder; 'Run' for the top-level run).

    subflowPath: readonly string[]

    Decomposition of subflowId into segments. Top-level → ['__root__']. Subflows live UNDER the root: a top-level subflow has path ['__root__', 'sf-x'].

    Settings
    Member Visibility

    On This Page
    Properties