footprintjs - v11.2.0
    Preparing search index...

    Interface FlowChartSpec

    interface FlowChartSpec {
        branchIds?: string[];
        budgetMs?: number;
        children?: FlowChartSpec[];
        description?: string;
        hasDecider?: boolean;
        hasSelector?: boolean;
        icon?: string;
        id: string;
        isDynamicParallel?: boolean;
        isLoopReference?: boolean;
        isParallelChild?: boolean;
        isStreaming?: boolean;
        isSubflowRoot?: boolean;
        loopTarget?: string;
        name: string;
        next?: FlowChartSpec;
        parallelGroupId?: string;
        retryAttempts?: number;
        streamId?: string;
        subflowId?: string;
        subflowName?: string;
        tags?: readonly string[];
        timeoutMs?: number;
        touches?: string;
        type?:
            | "stage"
            | "subflow"
            | "loop"
            | "decider"
            | "fork"
            | "selector"
            | "streaming";
    }
    Index
    branchIds? budgetMs? children? description? hasDecider? hasSelector? icon? id isDynamicParallel? isLoopReference? isParallelChild? isStreaming? isSubflowRoot? loopTarget? name next? parallelGroupId? retryAttempts? streamId? subflowId? subflowName? tags? timeoutMs? touches? type?
    branchIds?: string[]
    budgetMs?: number

    The chart's declared time budget, on the root only (see SerializedPipelineStructure.budgetMs).

    children?: FlowChartSpec[]
    description?: string
    hasDecider?: boolean
    hasSelector?: boolean
    icon?: string

    Semantic icon hint for visualization (e.g., "llm", "tool", "rag", "agent", "start")

    id: string
    isDynamicParallel?: boolean

    True for an addParallelForEach fan-out (type stays 'fork').

    isLoopReference?: boolean

    True when this node is a back-edge reference created by loopTo() — not an executable stage.

    isParallelChild?: boolean
    isStreaming?: boolean
    isSubflowRoot?: boolean
    loopTarget?: string
    name: string
    next?: FlowChartSpec
    parallelGroupId?: string
    retryAttempts?: number

    Total attempts allowed by this stage's declared retry policy — the count only (see SerializedPipelineStructure.retryAttempts).

    streamId?: string
    subflowId?: string
    subflowName?: string
    tags?: readonly string[]

    Declared tags on this stage, as-is (see SerializedPipelineStructure.tags).

    timeoutMs?: number

    The cap on one attempt (see SerializedPipelineStructure.timeoutMs).

    touches?: string

    The outside system this stage changes, by name (see SerializedPipelineStructure.touches).

    type?:
        | "stage"
        | "subflow"
        | "loop"
        | "decider"
        | "fork"
        | "selector"
        | "streaming"

    Node type — matches SerializedPipelineStructure.type for visualization alignment.

    Settings
    Member Visibility

    On This Page
    Properties