Class StateGraph<State, Update, N>

Type Parameters

  • State extends object | unknown
  • Update extends object | unknown = Partial<State>
  • N extends string = typeof START

Hierarchy (view full)

Constructors

constructor

Properties

branches channels compiled edges entryPoint? nodes supportMultipleEdges waitingEdges

Accessors

allEdges

Methods

addConditionalEdges addEdge addNode compile setEntryPoint setFinishPoint validate

Constructors

constructor

Properties

branches

branches: Record<string, Record<string, Branch<State, N>>>

channels

channels: Record<string, BaseChannel<unknown, unknown, unknown>>

compiled

compiled: boolean

edges

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

Optional entryPoint

entryPoint?: string

nodes

nodes: Record<N, Runnable<State, Update, RunnableConfig>>

supportMultipleEdges

supportMultipleEdges: boolean

waitingEdges

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

Accessors

allEdges

  • get allEdges(): Set<[string, string]>

  • Returns Set<[string, string]>

Methods

addConditionalEdges

  • addConditionalEdges(source): this

  • Parameters

    • source: BranchOptions<State, N>

    Returns this

  • addConditionalEdges(source, path, pathMap?): this

  • Parameters

    • source: N
    • path: ((input, config?) => string | string[] | Promise<string> | Promise<string[]>)
        • (input, config?): string | string[] | Promise<string> | Promise<string[]>

        • Parameters

          • input: State
          • Optional config: RunnableConfig

          Returns string | string[] | Promise<string> | Promise<string[]>

    • Optional pathMap: N[] | Record<string, "__end__" | N>

    Returns this

addEdge

  • addEdge(startKey, endKey): this

  • Parameters

    • startKey: "__start__" | N | N[]
    • endKey: "__end__" | N

    Returns this

addNode

compile

setEntryPoint

  • setEntryPoint(key): this

  • Parameters

    • key: N

    Returns this

    Deprecated

    use addEdge(START, key) instead

setFinishPoint

  • setFinishPoint(key): this

  • Parameters

    • key: N

    Returns this

    Deprecated

    use addEdge(key, END) instead

validate

  • validate(interrupt?): void

  • Parameters

    • Optional interrupt: string[]

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorbrancheschannelscompilededgesentryPointnodessupportMultipleEdgeswaitingEdgesallEdgesaddConditionalEdgesaddEdgeaddNodecompilesetEntryPointsetFinishPointvalidate