ADK for TypeScript: API Reference
    Preparing search index...

    Interface RunNodeOptions

    Options controlling a single ctx.runNode(...) execution.

    interface RunNodeOptions {
        nodeName?: string;
        overrideBranch?: string;
        overrideIsolationScope?: string;
        overrideNodePath?: string;
        runId?: string;
        useAsOutput?: boolean;
        useSubBranch?: boolean;
    }

    Properties

    nodeName?: string

    Deterministic tracking name; defaults to node.name.

    overrideBranch?: string

    Explicit branch, overriding the default/sub-branch computation.

    overrideIsolationScope?: string

    Explicit isolation scope, overriding inheritance from the parent.

    overrideNodePath?: string

    Explicit node path for the child (used by the dynamic scheduler to embed the run id, e.g. wf.node@1, so distinct runs are distinguishable on resume). Defaults to ${parent.nodePath}.${nodeName}.

    runId?: string

    Unique id for this specific run. Defaults to a per-node sequence — "1", "2", "3" in call order — which is what a resume matches checkpoints on.

    Supply one only when position is not stable but identity is (a reorderable collection: key it off the item's own id). Give it a non-numeric character so it cannot collide with the automatic sequence: an all-digit id is refused for any node ADK also numbers automatically in the same context, whichever call comes first.

    useAsOutput?: boolean

    If true, the child's output replaces the caller's output.

    useSubBranch?: boolean

    If true, run the child in an isolated sub-branch.

    Properties