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

    Class Workflow

    A graph-based workflow node. runImpl() IS the orchestration loop: SETUP (seed START triggers) → LOOP (schedule ready nodes, handle completions) → FINALIZE (collect the terminal output).

    Ported (Phase 2 subset) from google/adk-python workflow/_workflow.py. Replay/checkpointing, dynamic scheduling, and task/chat isolation scopes are added in later phases; hook points are marked with TODO(phase-N).

    Hierarchy (View Summary)

    Constructors

    Properties

    "[BASE_NODE_SIGNATURE_SYMBOL]": true

    Brand identifying this object as a BaseNode (see isBaseNode).

    "[WORKFLOW_SIGNATURE_SYMBOL]": true

    Brand identifying this object as a Workflow (see isWorkflow).

    description: string
    dynamicEntry?: DynamicEntry
    graph?: Graph
    inputSchema?: SchemaLike
    isolationScope?: string | true
    maxConcurrency?: number
    name: string
    outputSchema?: SchemaLike
    preparedRetryConfig?: PreparedRetryConfig

    The retry config with its exception filter normalized once, up front (see prepareRetryConfig). Used by the node runner so the retry hot path never re-normalizes or throws on a malformed config mid-retry.

    rerunOnResume: boolean
    retryConfig?: RetryConfig
    stateSchema?: SchemaLike
    timeout?: number
    waitForOutput: boolean

    Accessors

    • get requiresAllPredecessors(): boolean

      Whether this node must wait for ALL of its predecessors to trigger before it runs (fan-in barrier). Overridden by JoinNode.

      Returns boolean

    Methods

    • Runs the node, normalizing every yielded item into an Event. This is what the engine (and ctx.runNode()) consumes. Validates the input against inputSchema once, up front (skipping genai Content, which nodes coerce themselves).

      Parameters

      Returns AsyncGenerator<Event, void, void>

    • Validates node input against inputSchema (Content passes through). Only enforced for Zod schemas; a genai Schema is left unvalidated (see parseWithSchema).

      Parameters

      • input: unknown

      Returns unknown

    • Validates node output against outputSchema (Content passes through). Only enforced for Zod schemas; a genai Schema is left unvalidated (see parseWithSchema).

      Parameters

      • output: unknown

      Returns unknown