Interface CompiledGraphLike

Structural interface for a compiled LangGraph graph.

interface CompiledGraphLike {
    checkpointer?: unknown;
    getGraph?(...args: unknown[]): unknown;
    getState?(
        config: LangGraphRunnableConfig,
    ):
        | LangGraphStateSnapshot
        | Promise<LangGraphStateSnapshot | undefined>
        | undefined;
    invoke(
        input: LangGraphInvokeInput,
        config: LangGraphRunnableConfig,
    ): LangGraphInvokeOutput | Promise<LangGraphInvokeOutput>;
}

Properties

`Optional` `Readonly`checkpointer

checkpointer?: unknown

Optional checkpointer configured on the compiled graph for multi-turn state persistence.

Methods

`Optional`getGraph

getGraph?(...args: unknown[]): unknown
Optional helper returning the underlying graph representation.
Parameters
- ...args: unknown[]
Returns unknown
- Defined in core/src/agents/langgraph_agent.ts:111

`Optional`getState

getState?(
    config: LangGraphRunnableConfig,
):
    | LangGraphStateSnapshot
    | Promise<LangGraphStateSnapshot | undefined>
    | undefined
Retrieves the current graph state for the given runnable configuration.
Parameters
- config: LangGraphRunnableConfig
Returns LangGraphStateSnapshot | Promise<LangGraphStateSnapshot | undefined> | undefined
- Defined in core/src/agents/langgraph_agent.ts:116

invoke

invoke(
input: LangGraphInvokeInput,
config: LangGraphRunnableConfig,
): LangGraphInvokeOutput | Promise<LangGraphInvokeOutput>
Invokes the compiled graph with the given message list and runnable configuration.
Parameters
- input: LangGraphInvokeInput
- config: LangGraphRunnableConfig
Returns LangGraphInvokeOutput | Promise<LangGraphInvokeOutput>
- Defined in core/src/agents/langgraph_agent.ts:126