Class StateGraph<SD, S, U, N, I, O, C, NodeReturnType, InterruptType, WriterType>

A graph whose nodes communicate by reading and writing to a shared state. Each node takes a defined State as input and returns a Partial<State>.

Each state key can optionally be annotated with a reducer function that will be used to aggregate the values of that key received from multiple nodes. The signature of a reducer function is (left: Value, right: UpdateValue) => Value.

See Annotation for more on defining state.

After adding nodes and edges to your graph, you must call .compile() on it before you can use it.

Example

import {
  type BaseMessage,
  AIMessage,
  HumanMessage,
} from "@langchain/core/messages";
import { StateGraph, Annotation } from "@langchain/langgraph";

// Define a state with a single key named "messages" that will
// combine a returned BaseMessage or arrays of BaseMessages
const StateAnnotation = Annotation.Root({
  sentiment: Annotation<string>,
  messages: Annotation<BaseMessage[]>({
    reducer: (left: BaseMessage[], right: BaseMessage | BaseMessage[]) => {
      if (Array.isArray(right)) {
        return left.concat(right);
      }
      return left.concat([right]);
    },
    default: () => [],
  }),
});

const graphBuilder = new StateGraph(StateAnnotation);

// A node in the graph that returns an object with a "messages" key
// will update the state by combining the existing value with the returned one.
const myNode = (state: typeof StateAnnotation.State) => {
  return {
    messages: [new AIMessage("Some new response")],
    sentiment: "positive",
  };
};

const graph = graphBuilder
  .addNode("myNode", myNode)
  .addEdge("__start__", "myNode")
  .addEdge("myNode", "__end__")
  .compile();

await graph.invoke({ messages: [new HumanMessage("how are you?")] });

// {
//   messages: [HumanMessage("how are you?"), AIMessage("Some new response")],
//   sentiment: "positive",
// }

Type Parameters

SD extends SDZod | unknown
S = SD extends SDZod ? StateType<ToStateDefinition<SD>> : SD
U = SD extends SDZod ? UpdateType<ToStateDefinition<SD>> : Partial<S>
N extends string = typeof START
I extends SDZod = SD extends SDZod ? ToStateDefinition<SD> : StateDefinition
O extends SDZod = SD extends SDZod ? ToStateDefinition<SD> : StateDefinition
C extends SDZod = StateDefinition
NodeReturnType = unknown
InterruptType = unknown
WriterType = unknown

Hierarchy (View Summary)

Graph<N, S, U, StateGraphNodeSpec<S, U>, ToStateDefinition<C>>
- StateGraph

Index

Constructors

constructor

new StateGraph<
 SD extends unknown,
 S = SD extends SDZod ? StateType<ToStateDefinition<SD<SD>>> : SD,
 U = SD extends SDZod ? UpdateType<ToStateDefinition<SD<SD>>> : Partial<S>,
 N extends string = "__start__",
 I extends
 SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition,
 O extends
 SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition,
 C extends SDZod = StateDefinition,
 NodeReturnType = unknown,
 InterruptType = unknown,
 WriterType = unknown,
>(
 state: SD extends StateDefinition ? AnnotationRoot<SD<SD>> : never,
 options?: {
 context?: C | AnnotationRoot<ToStateDefinition<C>>;
 input?: I | AnnotationRoot<ToStateDefinition>;
 interrupt?: InterruptType;
 nodes?: N[];
 output?: O | AnnotationRoot<ToStateDefinition<O>>;
 writer?: WriterType;
 },
): StateGraph<
 SD,
 S,
 U,
 N,
 I,
 O,
 C,
 NodeReturnType,
 InterruptType,
 WriterType,
>
Type Parameters
- SD extends unknown
- S = SD extends SDZod ? StateType<ToStateDefinition<SD<SD>>> : SD
- U = SD extends SDZod ? UpdateType<ToStateDefinition<SD<SD>>> : Partial<S>
- N extends string = "__start__"
- I extends SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition
- O extends SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition
- C extends SDZod = StateDefinition
- NodeReturnType = unknown
- InterruptType = unknown
- WriterType = unknown
Parameters
- state: SD extends StateDefinition ? AnnotationRoot<SD<SD>> : never
- Optionaloptions: {
 context?: C | AnnotationRoot<ToStateDefinition<C>>;
 input?: I | AnnotationRoot<ToStateDefinition>;
 interrupt?: InterruptType;
 nodes?: N[];
 output?: O | AnnotationRoot<ToStateDefinition<O>>;
 writer?: WriterType;
 }
Returns StateGraph<SD, S, U, N, I, O, C, NodeReturnType, InterruptType, WriterType>
Overrides Graph.constructor
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:307
new StateGraph<
 SD extends unknown,
 S = SD extends SDZod ? StateType<ToStateDefinition<SD<SD>>> : SD,
 U = SD extends SDZod ? UpdateType<ToStateDefinition<SD<SD>>> : Partial<S>,
 N extends string = "__start__",
 I extends
 SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition,
 O extends
 SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition,
 C extends SDZod = StateDefinition,
 NodeReturnType = unknown,
 InterruptType = unknown,
 WriterType = unknown,
>(
 state: SD extends InteropZodObject ? SD<SD> : never,
 options?: {
 context?: C | AnnotationRoot<ToStateDefinition<C>>;
 input?: I | AnnotationRoot<ToStateDefinition>;
 interrupt?: InterruptType;
 nodes?: N[];
 output?: O | AnnotationRoot<ToStateDefinition<O>>;
 writer?: WriterType;
 },
): StateGraph<
 SD,
 S,
 U,
 N,
 I,
 O,
 C,
 NodeReturnType,
 InterruptType,
 WriterType,
>
Type Parameters
- SD extends unknown
- S = SD extends SDZod ? StateType<ToStateDefinition<SD<SD>>> : SD
- U = SD extends SDZod ? UpdateType<ToStateDefinition<SD<SD>>> : Partial<S>
- N extends string = "__start__"
- I extends SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition
- O extends SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition
- C extends SDZod = StateDefinition
- NodeReturnType = unknown
- InterruptType = unknown
- WriterType = unknown
Parameters
- state: SD extends InteropZodObject ? SD<SD> : never
- Optionaloptions: {
 context?: C | AnnotationRoot<ToStateDefinition<C>>;
 input?: I | AnnotationRoot<ToStateDefinition>;
 interrupt?: InterruptType;
 nodes?: N[];
 output?: O | AnnotationRoot<ToStateDefinition<O>>;
 writer?: WriterType;
 }
Returns StateGraph<SD, S, U, N, I, O, C, NodeReturnType, InterruptType, WriterType>
Overrides Graph<N, S, U, StateGraphNodeSpec<S, U>, ToStateDefinition<C>>.constructor
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:321
new StateGraph<
 SD extends unknown,
 S = SD extends SDZod ? StateType<ToStateDefinition<SD<SD>>> : SD,
 U = SD extends SDZod ? UpdateType<ToStateDefinition<SD<SD>>> : Partial<S>,
 N extends string = "__start__",
 I extends
 SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition,
 O extends
 SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition,
 C extends SDZod = StateDefinition,
 NodeReturnType = unknown,
 InterruptType = unknown,
 WriterType = unknown,
>(
 fields: SD extends StateDefinition
 ? StateGraphArgsWithInputOutputSchemas<SD<SD>, ToStateDefinition<O>>
 : never,
 contextSchema?: C | AnnotationRoot<ToStateDefinition<C>>,
): StateGraph<
 SD,
 S,
 U,
 N,
 I,
 O,
 C,
 NodeReturnType,
 InterruptType,
 WriterType,
>
Type Parameters
- SD extends unknown
- S = SD extends SDZod ? StateType<ToStateDefinition<SD<SD>>> : SD
- U = SD extends SDZod ? UpdateType<ToStateDefinition<SD<SD>>> : Partial<S>
- N extends string = "__start__"
- I extends SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition
- O extends SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition
- C extends SDZod = StateDefinition
- NodeReturnType = unknown
- InterruptType = unknown
- WriterType = unknown
Parameters
- fields: SD extends StateDefinition
 ? StateGraphArgsWithInputOutputSchemas<SD<SD>, ToStateDefinition<O>>
 : never
- OptionalcontextSchema: C | AnnotationRoot<ToStateDefinition<C>>
Returns StateGraph<SD, S, U, N, I, O, C, NodeReturnType, InterruptType, WriterType>
Overrides Graph<N, S, U, StateGraphNodeSpec<S, U>, ToStateDefinition<C>>.constructor
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:335
new StateGraph<
 SD extends unknown,
 S = SD extends SDZod ? StateType<ToStateDefinition<SD<SD>>> : SD,
 U = SD extends SDZod ? UpdateType<ToStateDefinition<SD<SD>>> : Partial<S>,
 N extends string = "__start__",
 I extends
 SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition,
 O extends
 SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition,
 C extends SDZod = StateDefinition,
 NodeReturnType = unknown,
 InterruptType = unknown,
 WriterType = unknown,
>(
 fields: SD extends StateDefinition
 ? | AnnotationRoot<SD<SD>>
 | StateGraphArgsWithStateSchema<
 SD<SD>,
 ToStateDefinition,
 ToStateDefinition<O>,
 >
 : never,
 contextSchema?: C | AnnotationRoot<ToStateDefinition<C>>,
): StateGraph<
 SD,
 S,
 U,
 N,
 I,
 O,
 C,
 NodeReturnType,
 InterruptType,
 WriterType,
>
Type Parameters
- SD extends unknown
- S = SD extends SDZod ? StateType<ToStateDefinition<SD<SD>>> : SD
- U = SD extends SDZod ? UpdateType<ToStateDefinition<SD<SD>>> : Partial<S>
- N extends string = "__start__"
- I extends SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition
- O extends SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition
- C extends SDZod = StateDefinition
- NodeReturnType = unknown
- InterruptType = unknown
- WriterType = unknown
Parameters
- fields: SD extends StateDefinition
 ? | AnnotationRoot<SD<SD>>
 | StateGraphArgsWithStateSchema<
 SD<SD>,
 ToStateDefinition,
 ToStateDefinition<O>,
 >
 : never
- OptionalcontextSchema: C | AnnotationRoot<ToStateDefinition<C>>
Returns StateGraph<SD, S, U, N, I, O, C, NodeReturnType, InterruptType, WriterType>
Overrides Graph<N, S, U, StateGraphNodeSpec<S, U>, ToStateDefinition<C>>.constructor
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:342
new StateGraph<
 SD extends unknown,
 S = SD extends SDZod ? StateType<ToStateDefinition<SD<SD>>> : SD,
 U = SD extends SDZod ? UpdateType<ToStateDefinition<SD<SD>>> : Partial<S>,
 N extends string = "__start__",
 I extends
 SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition,
 O extends
 SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition,
 C extends SDZod = StateDefinition,
 NodeReturnType = unknown,
 InterruptType = unknown,
 WriterType = unknown,
>(
 fields: SD extends StateDefinition
 ? SD<SD>
 | StateGraphArgs<S>
 : StateGraphArgs<S>,
 contextSchema?: C | AnnotationRoot<ToStateDefinition<C>>,
): StateGraph<
 SD,
 S,
 U,
 N,
 I,
 O,
 C,
 NodeReturnType,
 InterruptType,
 WriterType,
>
Type Parameters
- SD extends unknown
- S = SD extends SDZod ? StateType<ToStateDefinition<SD<SD>>> : SD
- U = SD extends SDZod ? UpdateType<ToStateDefinition<SD<SD>>> : Partial<S>
- N extends string = "__start__"
- I extends SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition
- O extends SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition
- C extends SDZod = StateDefinition
- NodeReturnType = unknown
- InterruptType = unknown
- WriterType = unknown
Parameters
- fields: SD extends StateDefinition ? SD<SD> | StateGraphArgs<S> : StateGraphArgs<S>
- OptionalcontextSchema: C | AnnotationRoot<ToStateDefinition<C>>
Returns StateGraph<SD, S, U, N, I, O, C, NodeReturnType, InterruptType, WriterType>
Deprecated
Use Annotation.Root or zod for state definition instead.
Overrides Graph<N, S, U, StateGraphNodeSpec<S, U>, ToStateDefinition<C>>.constructor
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:356
new StateGraph<
 SD extends unknown,
 S = SD extends SDZod ? StateType<ToStateDefinition<SD<SD>>> : SD,
 U = SD extends SDZod ? UpdateType<ToStateDefinition<SD<SD>>> : Partial<S>,
 N extends string = "__start__",
 I extends
 SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition,
 O extends
 SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition,
 C extends SDZod = StateDefinition,
 NodeReturnType = unknown,
 InterruptType = unknown,
 WriterType = unknown,
>(
 fields: SD extends InteropZodObject
 ? SD<SD>
 | ZodStateGraphArgsWithStateSchema<SD<SD>, I, O>
 : never,
 contextSchema?: C | AnnotationRoot<ToStateDefinition<C>>,
): StateGraph<
 SD,
 S,
 U,
 N,
 I,
 O,
 C,
 NodeReturnType,
 InterruptType,
 WriterType,
>
Type Parameters
- SD extends unknown
- S = SD extends SDZod ? StateType<ToStateDefinition<SD<SD>>> : SD
- U = SD extends SDZod ? UpdateType<ToStateDefinition<SD<SD>>> : Partial<S>
- N extends string = "__start__"
- I extends SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition
- O extends SDZod = SD extends SDZod ? ToStateDefinition<SD<SD>> : StateDefinition
- C extends SDZod = StateDefinition
- NodeReturnType = unknown
- InterruptType = unknown
- WriterType = unknown
Parameters
- fields: SD extends InteropZodObject
 ? SD<SD>
 | ZodStateGraphArgsWithStateSchema<SD<SD>, I, O>
 : never
- OptionalcontextSchema: C | AnnotationRoot<ToStateDefinition<C>>
Returns StateGraph<SD, S, U, N, I, O, C, NodeReturnType, InterruptType, WriterType>
Overrides Graph<N, S, U, StateGraphNodeSpec<S, U>, ToStateDefinition<C>>.constructor
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:363

Properties

branches

branches: Record<string, Record<string, Branch<RunInput, N, any>>>

channels

channels: Record<string, BaseChannel> = {}

compiled

compiled: boolean = false

edges

edges: Set<["__start__" | N, "__end__" | N]>

`Optional`entryPoint

entryPoint?: string

Node

Node: StrictNodeAction<S, U, C, N, InterruptType, WriterType>

nodes

nodes: Record<N, NodeSpecType>

waitingEdges

waitingEdges: Set<[N[], N]> = ...

Accessors

allEdges

get allEdges(): Set<[string, string]>
Returns Set<[string, string]>
Overrides Graph.allEdges
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:491

Methods

_addSchema

_addSchema(stateDefinition: SDZod): void
Parameters
- stateDefinition: SDZod
Returns void
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:500

addConditionalEdges

addConditionalEdges(
 source: BranchOptions<
 S,
 N,
 LangGraphRunnableConfig<StateType<ToStateDefinition<C>>>,
 >,
): this
Parameters
- source: BranchOptions<S, N, LangGraphRunnableConfig<StateType<ToStateDefinition<C>>>>
Returns this
Inherited from Graph.addConditionalEdges
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/graph.ts:348
addConditionalEdges(
 source: N,
 path: RunnableLike<
 S,
 BranchPathReturnValue,
 LangGraphRunnableConfig<StateType<ToStateDefinition<C>>>,
 >,
 pathMap?: Record<string, "__end__" | N> | ("__end__" | N)[],
): this
Parameters
- source: N
- path: RunnableLike<
 S,
 BranchPathReturnValue,
 LangGraphRunnableConfig<StateType<ToStateDefinition<C>>>,
 >
- OptionalpathMap: Record<string, "__end__" | N> | ("__end__" | N)[]
Returns this
Inherited from Graph.addConditionalEdges
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/graph.ts:352

addEdge

addEdge(startKey: "__start__" | N | N[], endKey: "__end__" | N): this
Parameters
- startKey: "__start__" | N | N[]
- endKey: "__end__" | N
Returns this
Overrides Graph.addEdge
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:732

addNode

addNode<
 K extends string,
 NodeMap extends Record<K, NodeAction<S, U, C, InterruptType, WriterType>>,
>(
 nodes: NodeMap,
): StateGraph<
 SD,
 S,
 U,
 N
 | K,
 I,
 O,
 C,
 MergeReturnType<
 NodeReturnType,
 {
 [key in string
 | number
 | symbol]: NodeMap[key] extends NodeAction<
 S,
 U,
 C,
 InterruptType,
 WriterType,
 >
 ? U
 : never
 },
 >,
>
Type Parameters
- K extends string
- NodeMap extends Record<K, NodeAction<S, U, C, InterruptType, WriterType>>
Parameters
- nodes: NodeMap
Returns StateGraph<
 SD,
 S,
 U,
 N
 | K,
 I,
 O,
 C,
 MergeReturnType<
 NodeReturnType,
 {
 [key in string
 | number
 | symbol]: NodeMap[key] extends NodeAction<
 S,
 U,
 C,
 InterruptType,
 WriterType,
 >
 ? U
 : never
 },
 >,
>
Overrides Graph.addNode
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:527
addNode<K extends string, NodeInput = S, NodeOutput = U>(
 nodes: [
 key: K,
 action: NodeAction<NodeInput, NodeOutput, C, InterruptType, WriterType>,
 options?: StateGraphAddNodeOptions<string>,
 ][],
): StateGraph<
 SD,
 S,
 U,
 N
 | K,
 I,
 O,
 C,
 MergeReturnType<NodeReturnType, { [key in string]: NodeOutput }>,
>
Type Parameters
- K extends string
- NodeInput = S
- NodeOutput = U
Parameters
- nodes: [
 key: K,
 action: NodeAction<NodeInput, NodeOutput, C, InterruptType, WriterType>,
 options?: StateGraphAddNodeOptions<string>,
 ][]
Returns StateGraph<
 SD,
 S,
 U,
 N
 | K,
 I,
 O,
 C,
 MergeReturnType<NodeReturnType, { [key in string]: NodeOutput }>,
>
Overrides Graph.addNode
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:556
addNode<K extends string, NodeInput = S, NodeOutput = U>(
 key: K,
 action: NodeAction<NodeInput, NodeOutput, C, InterruptType, WriterType>,
 options?: StateGraphAddNodeOptions<string>,
): StateGraph<
 SD,
 S,
 U,
 N
 | K,
 I,
 O,
 C,
 MergeReturnType<NodeReturnType, { [key in string]: NodeOutput }>,
>
Type Parameters
- K extends string
- NodeInput = S
- NodeOutput = U
Parameters
- key: K
- action: NodeAction<NodeInput, NodeOutput, C, InterruptType, WriterType>
- Optionaloptions: StateGraphAddNodeOptions<string>
Returns StateGraph<
 SD,
 S,
 U,
 N
 | K,
 I,
 O,
 C,
 MergeReturnType<NodeReturnType, { [key in string]: NodeOutput }>,
>
Overrides Graph.addNode
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:580
addNode<K extends string, NodeInput = S>(
 key: K,
 action: NodeAction<NodeInput, U, C, InterruptType, WriterType>,
 options?: StateGraphAddNodeOptions<string>,
): StateGraph<SD, S, U, N | K, I, O, C, NodeReturnType>
Type Parameters
- K extends string
- NodeInput = S
Parameters
- key: K
- action: NodeAction<NodeInput, U, C, InterruptType, WriterType>
- Optionaloptions: StateGraphAddNodeOptions<string>
Returns StateGraph<SD, S, U, N | K, I, O, C, NodeReturnType>
Overrides Graph.addNode
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:595

addSequence

addSequence<K extends string, NodeInput = S, NodeOutput = U>(
 nodes: [
 key: K,
 action: NodeAction<NodeInput, NodeOutput, C, InterruptType, WriterType>,
 options?: StateGraphAddNodeOptions<string>,
 ][],
): StateGraph<
 SD,
 S,
 U,
 N
 | K,
 I,
 O,
 C,
 MergeReturnType<NodeReturnType, { [key in string]: NodeOutput }>,
>
Type Parameters
- K extends string
- NodeInput = S
- NodeOutput = U
Parameters
- nodes: [
 key: K,
 action: NodeAction<NodeInput, NodeOutput, C, InterruptType, WriterType>,
 options?: StateGraphAddNodeOptions<string>,
 ][]
Returns StateGraph<
 SD,
 S,
 U,
 N
 | K,
 I,
 O,
 C,
 MergeReturnType<NodeReturnType, { [key in string]: NodeOutput }>,
>
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:767
addSequence<
 K extends string,
 NodeMap extends Record<K, NodeAction<S, U, C, InterruptType, WriterType>>,
>(
 nodes: NodeMap,
): StateGraph<
 SD,
 S,
 U,
 N
 | K,
 I,
 O,
 C,
 MergeReturnType<
 NodeReturnType,
 {
 [key in string
 | number
 | symbol]: NodeMap[key] extends NodeAction<
 S,
 U,
 C,
 InterruptType,
 WriterType,
 >
 ? U
 : never
 },
 >,
>
Type Parameters
- K extends string
- NodeMap extends Record<K, NodeAction<S, U, C, InterruptType, WriterType>>
Parameters
- nodes: NodeMap
Returns StateGraph<
 SD,
 S,
 U,
 N
 | K,
 I,
 O,
 C,
 MergeReturnType<
 NodeReturnType,
 {
 [key in string
 | number
 | symbol]: NodeMap[key] extends NodeAction<
 S,
 U,
 C,
 InterruptType,
 WriterType,
 >
 ? U
 : never
 },
 >,
>
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:784

compile

compile(
 __namedParameters?: {
 cache?: any;
 checkpointer?: any;
 description?: string;
 interruptAfter?: any;
 interruptBefore?: any;
 name?: string;
 store?: any;
 },
): CompiledStateGraph<
 { [K in string
 | number
 | symbol]: S[K] },
 { [K in string | number | symbol]: U[K] },
 N,
 I,
 O,
 C,
 NodeReturnType,
 InterruptType,
 WriterType,
>
Parameters
- __namedParameters: {
 cache?: any;
 checkpointer?: any;
 description?: string;
 interruptAfter?: any;
 interruptBefore?: any;
 name?: string;
 store?: any;
 } = {}
Returns CompiledStateGraph<
 { [K in string
 | number
 | symbol]: S[K] },
 { [K in string | number | symbol]: U[K] },
 N,
 I,
 O,
 C,
 NodeReturnType,
 InterruptType,
 WriterType,
>
Overrides Graph.compile
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/state.ts:879

setEntryPoint

setEntryPoint(key: N): this
Parameters
- key: N
Returns this
Deprecated
use addEdge(START, key) instead
Inherited from Graph.setEntryPoint
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/graph.ts:426

setFinishPoint

setFinishPoint(key: N): this
Parameters
- key: N
Returns this
Deprecated
use addEdge(key, END) instead
Inherited from Graph.setFinishPoint
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/graph.ts:437

validate

validate(interrupt?: string[]): void
Parameters
- Optionalinterrupt: string[]
Returns void
Inherited from Graph.validate
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/graph.ts:499

`Protected`warnIfCompiled

warnIfCompiled(message: string): void
Parameters
- message: string
Returns void
Inherited from Graph.warnIfCompiled
- Defined in remotes/langchain-ai/langgraphjs/v1/libs/langgraph/src/graph/graph.ts:215

Class StateGraph<SD, S, U, N, I, O, C, NodeReturnType, InterruptType, WriterType>

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns StateGraph<SD, S, U, N, I, O, C, NodeReturnType, InterruptType, WriterType>

Type Parameters

Parameters

Returns StateGraph<SD, S, U, N, I, O, C, NodeReturnType, InterruptType, WriterType>

Type Parameters

Parameters

Returns StateGraph<SD, S, U, N, I, O, C, NodeReturnType, InterruptType, WriterType>

Type Parameters

Parameters

Returns StateGraph<SD, S, U, N, I, O, C, NodeReturnType, InterruptType, WriterType>

Type Parameters

Parameters

Returns StateGraph<SD, S, U, N, I, O, C, NodeReturnType, InterruptType, WriterType>

Deprecated

Type Parameters

Parameters

Returns StateGraph<SD, S, U, N, I, O, C, NodeReturnType, InterruptType, WriterType>

Properties

branches

channels

compiled

edges

OptionalentryPoint

Node

nodes

waitingEdges

Accessors

allEdges

Returns Set<[string, string]>

Methods

_addSchema

Parameters

Returns void

addConditionalEdges

Parameters

Returns this

Parameters

Returns this

addEdge

Parameters

Returns this

addNode

Type Parameters

Parameters

Returns StateGraph< SD, S, U, N | K, I, O, C, MergeReturnType< NodeReturnType, { [key in string | number | symbol]: NodeMap[key] extends NodeAction< S, U, C, InterruptType, WriterType, > ? U : never }, >,>

Type Parameters

Parameters

Returns StateGraph< SD, S, U, N | K, I, O, C, MergeReturnType<NodeReturnType, { [key in string]: NodeOutput }>,>

Type Parameters

Parameters

Returns StateGraph< SD, S, U, N | K, I, O, C, MergeReturnType<NodeReturnType, { [key in string]: NodeOutput }>,>

Type Parameters

Parameters

Returns StateGraph<SD, S, U, N | K, I, O, C, NodeReturnType>

addSequence

Type Parameters

Parameters

Returns StateGraph< SD, S, U, N | K, I, O, C, MergeReturnType<NodeReturnType, { [key in string]: NodeOutput }>,>

Type Parameters

Parameters

Returns StateGraph< SD, S, U, N | K, I, O, C, MergeReturnType< NodeReturnType, { [key in string | number | symbol]: NodeMap[key] extends NodeAction< S, U, C, InterruptType, WriterType, > ? U : never }, >,>

compile

Parameters

Returns CompiledStateGraph< { [K in string | number | symbol]: S[K] }, { [K in string | number | symbol]: U[K] }, N, I, O, C, NodeReturnType, InterruptType, WriterType,>

setEntryPoint

Parameters

Returns this

`Optional`entryPoint

Returns StateGraph<
SD,
S,
U,
N
| K,
I,
O,
C,
MergeReturnType<
NodeReturnType,
{
[key in string
| number
| symbol]: NodeMap[key] extends NodeAction<
S,
U,
C,
InterruptType,
WriterType,
>
? U
: never
},
>,
>

Returns StateGraph<
SD,
S,
U,
N
| K,
I,
O,
C,
MergeReturnType<NodeReturnType, { [key in string]: NodeOutput }>,
>

Returns StateGraph<
SD,
S,
U,
N
| K,
I,
O,
C,
MergeReturnType<NodeReturnType, { [key in string]: NodeOutput }>,
>

Returns StateGraph<
SD,
S,
U,
N
| K,
I,
O,
C,
MergeReturnType<NodeReturnType, { [key in string]: NodeOutput }>,
>

Returns StateGraph<
SD,
S,
U,
N
| K,
I,
O,
C,
MergeReturnType<
NodeReturnType,
{
[key in string
| number
| symbol]: NodeMap[key] extends NodeAction<
S,
U,
C,
InterruptType,
WriterType,
>
? U
: never
},
>,
>

Returns CompiledStateGraph<
{ [K in string
| number
| symbol]: S[K] },
{ [K in string | number | symbol]: U[K] },
N,
I,
O,
C,
NodeReturnType,
InterruptType,
WriterType,
>

`Protected`warnIfCompiled