Showing content from https://langchain-ai.github.io/langgraphjs/reference/classes/langgraph.StateGraph.html below:
StateGraph | API Reference
Class StateGraph<SD, S, U, N, I, O, C, NodeReturnType> Type Parameters
Hierarchy (view full)
- Graph<N, S, U, StateGraphNodeSpec<S, U>, ToStateDefinition<C>>
- Defined in libs/langgraph/dist/graph/state.d.ts:118
Index Constructors Properties Accessors Methods Constructors constructor
- new StateGraph<SD, S, U, N, I, O, C, NodeReturnType>(fields, contextSchema?): StateGraph<SD, S, U, N, I, O, C, NodeReturnType>
- Type Parameters
Returns StateGraph<SD, S, U, N, I, O, C, NodeReturnType>
Overrides Graph.constructor
- Defined in libs/langgraph/dist/graph/state.d.ts:144
- new StateGraph<SD, S, U, N, I, O, C, NodeReturnType>(fields, contextSchema?): StateGraph<SD, S, U, N, I, O, C, NodeReturnType>
- Type Parameters
Returns StateGraph<SD, S, U, N, I, O, C, NodeReturnType>
Overrides Graph<N, S, U, StateGraphNodeSpec<S, U>, ToStateDefinition<C>>.constructor
- Defined in libs/langgraph/dist/graph/state.d.ts:145
- new StateGraph<SD, S, U, N, I, O, C, NodeReturnType>(fields, contextSchema?): StateGraph<SD, S, U, N, I, O, C, NodeReturnType>
- Type Parameters
Returns StateGraph<SD, S, U, N, I, O, C, NodeReturnType>
Overrides Graph<N, S, U, StateGraphNodeSpec<S, U>, ToStateDefinition<C>>.constructor
- Defined in libs/langgraph/dist/graph/state.d.ts:147
- new StateGraph<SD, S, U, N, I, O, C, NodeReturnType>(fields, contextSchema?): StateGraph<SD, S, U, N, I, O, C, NodeReturnType>
- Type Parameters
Parameters
- fields: SD extends InteropZodObject
? SD<SD> | ZodStateGraphArgsWithStateSchema<SD<SD>, I, O>
: never
Optional
contextSchema: C | AnnotationRoot<ToStateDefinition<C>>
Returns StateGraph<SD, S, U, N, I, O, C, NodeReturnType>
Overrides Graph<N, S, U, StateGraphNodeSpec<S, U>, ToStateDefinition<C>>.constructor
- Defined in libs/langgraph/dist/graph/state.d.ts:148
Properties branches branches: Record<string, Record<string, Branch<S, N, any>>>
Inherited from Graph.branches
- Defined in libs/langgraph/dist/graph/graph.d.ts:43
channels channels: Record<string, BaseChannel<unknown, unknown, unknown>>
- Defined in libs/langgraph/dist/graph/state.d.ts:119
compiled
compiled: boolean
Inherited from Graph.compiled
- Defined in libs/langgraph/dist/graph/graph.d.ts:45
edges edges: Set<["__start__" | N, "__end__" | N]>
Inherited from Graph.edges
- Defined in libs/langgraph/dist/graph/graph.d.ts:42
Optional
entryPoint
entryPoint?: string
Inherited from Graph.entryPoint
- Defined in libs/langgraph/dist/graph/graph.d.ts:44
nodes nodes: Record<N, StateGraphNodeSpec<S, U>>
Inherited from Graph.nodes
- Defined in libs/langgraph/dist/graph/graph.d.ts:41
waitingEdges waitingEdges: Set<[N[], N]>
- Defined in libs/langgraph/dist/graph/state.d.ts:120
Accessors allEdges
- get allEdges(): Set<[string, string]>
- Returns Set<[string, string]>
Overrides Graph.allEdges
- Defined in libs/langgraph/dist/graph/state.d.ts:149
Methods _addSchema
- _addSchema(stateDefinition): void
- Parameters
Returns void
- Defined in libs/langgraph/dist/graph/state.d.ts:150
addConditionalEdges
addEdge
- addEdge(startKey, endKey): this
- Parameters
- startKey: "__start__" | N | N[]
- endKey: "__end__" | N
Returns this
Overrides Graph.addEdge
- Defined in libs/langgraph/dist/graph/state.d.ts:165
addNode
- addNode<K, NodeMap>(nodes): StateGraph<SD, S, U, N | K, I, O, C, MergeReturnType<NodeReturnType, {
[key in string | number | symbol]: NodeMap[key] extends NodeAction<S, U, C>
? U
: never
}>>
- Type Parameters
- K extends string
- NodeMap extends Record<K, NodeAction<S, U, C>>
Returns StateGraph<SD, S, U, N | K, I, O, C, MergeReturnType<NodeReturnType, {
[key in string | number | symbol]: NodeMap[key] extends NodeAction<S, U, C>
? U
: never
}>>
Overrides Graph.addNode
- Defined in libs/langgraph/dist/graph/state.d.ts:151
- addNode<K, NodeInput, NodeOutput>(nodes): 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>, options?: StateGraphAddNodeOptions<string>][]
Returns StateGraph<SD, S, U, N | K, I, O, C, MergeReturnType<NodeReturnType, {
[key in string]: NodeOutput
}>>
Overrides Graph.addNode
- Defined in libs/langgraph/dist/graph/state.d.ts:154
- addNode<K, NodeInput, NodeOutput>(key, action, options?): 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
Returns StateGraph<SD, S, U, N | K, I, O, C, MergeReturnType<NodeReturnType, {
[key in string]: NodeOutput
}>>
Overrides Graph.addNode
- Defined in libs/langgraph/dist/graph/state.d.ts:161
- addNode<K, NodeInput>(key, action, options?): 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>
Optional
options: StateGraphAddNodeOptions<string>
Returns StateGraph<SD, S, U, N | K, I, O, C, NodeReturnType>
Overrides Graph.addNode
- Defined in libs/langgraph/dist/graph/state.d.ts:164
addSequence
- addSequence<K, NodeInput, NodeOutput>(nodes): 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>, options?: StateGraphAddNodeOptions<string>][]
Returns StateGraph<SD, S, U, N | K, I, O, C, MergeReturnType<NodeReturnType, {
[key in string]: NodeOutput
}>>
- Defined in libs/langgraph/dist/graph/state.d.ts:166
- addSequence<K, NodeMap>(nodes): StateGraph<SD, S, U, N | K, I, O, C, MergeReturnType<NodeReturnType, {
[key in string | number | symbol]: NodeMap[key] extends NodeAction<S, U, C>
? U
: never
}>>
- Type Parameters
- K extends string
- NodeMap extends Record<K, NodeAction<S, U, C>>
Returns StateGraph<SD, S, U, N | K, I, O, C, MergeReturnType<NodeReturnType, {
[key in string | number | symbol]: NodeMap[key] extends NodeAction<S, U, C>
? U
: never
}>>
- Defined in libs/langgraph/dist/graph/state.d.ts:173
compile
- compile(__namedParameters?): CompiledStateGraph<{
[K in string | number | symbol]: S[K]
}, {
[K in string | number | symbol]: U[K]
}, N, I, O, C, NodeReturnType>
- Parameters
Optional
__namedParameters: {
cache?: BaseCache<unknown>;
checkpointer?: boolean | BaseCheckpointSaver<number>;
description?: string;
interruptAfter?: "*" | N[];
interruptBefore?: "*" | N[];
name?: string;
store?: BaseStore;
}
Optional
cache?: BaseCache<unknown>
Optional
checkpointer?: boolean | BaseCheckpointSaver<number>
Optional
description?: string
Optional
interruptAfter?: "*" | N[]
Optional
interruptBefore?: "*" | N[]
Optional
name?: string
Optional
store?: BaseStore
Returns CompiledStateGraph<{
[K in string | number | symbol]: S[K]
}, {
[K in string | number | symbol]: U[K]
}, N, I, O, C, NodeReturnType>
Overrides Graph.compile
- Defined in libs/langgraph/dist/graph/state.d.ts:176
setEntryPoint
setFinishPoint
validate
Protected
warnIfCompiled
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4