footprintjs - v11.2.0
    Preparing search index...

    Interface RunnableFlowChart<TOut, TScope>

    FlowChart enriched with d3-style run methods and self-describing outputs.

    Extends builder.FlowChart (which already carries buildTimeStructure, description, stageDescriptions, inputSchema, outputSchema, outputMapper) and adds the runtime methods attached by makeRunnable().

    interface RunnableFlowChart<TOut = any, TScope = any> {
        buildTimeStructure: SerializedPipelineStructure;
        description: string;
        enableNarrative?: boolean;
        inputSchema?: unknown;
        logger?: ILogger;
        outputMapper?: (finalScope: Record<string, unknown>) => unknown;
        outputSchema?: unknown;
        root: StageNode<TOut, TScope>;
        scopeFactory?: ScopeFactory<TScope>;
        stageDescriptions: Map<string, string>;
        stageMap: Map<string, StageHandler<TOut, TScope>>;
        subflows?: Record<string, { root: StageNode<TOut, TScope> }>;
        recorder(r: ScopeRecorder | FlowRecorder): RunContext<TOut, TScope>;
        redact(policy: RedactionPolicy): RunContext<TOut, TScope>;
        run(options?: RunOptions): Promise<RunResult>;
        timeBudget(options?: TimeBudgetOptions): TimeBudgetReport;
        toMCPTool(): MCPToolDescription;
        toMermaid(): string;
        toOpenAPI(options?: ChartOpenAPIOptions): object;
    }

    Type Parameters

    • TOut = any
    • TScope = any

    Hierarchy

    Index
    buildTimeStructure description enableNarrative? inputSchema? logger? outputMapper? outputSchema? root scopeFactory? stageDescriptions stageMap subflows?
    recorder redact run timeBudget toMCPTool toMermaid toOpenAPI
    buildTimeStructure: SerializedPipelineStructure
    description: string
    enableNarrative?: boolean
    inputSchema?: unknown

    Input schema (Zod or JSON Schema) — declared via .contract().

    logger?: ILogger
    outputMapper?: (finalScope: Record<string, unknown>) => unknown

    Output mapper — extracts response from final scope.

    outputSchema?: unknown

    Output schema (Zod or JSON Schema) — declared via .contract().

    root: StageNode<TOut, TScope>
    scopeFactory?: ScopeFactory<TScope>

    Scope factory — auto-embedded by flowChart(). Executor reads this if no factory param.

    stageDescriptions: Map<string, string>
    stageMap: Map<string, StageHandler<TOut, TScope>>
    subflows?: Record<string, { root: StageNode<TOut, TScope> }>

    • Generate a Mermaid flowchart diagram string from the chart's node graph.

      Returns string

    Settings
    Member Visibility

    On This Page
    Properties
    Methods