langchain.js
    Preparing search index...

    Interface LangGraphRunnableConfig<ContextType>

    interface LangGraphRunnableConfig<
        ContextType extends Record<string, any> = Record<string, any>,
    > {
        context?: ContextType;
        interrupt?: (value: unknown) => unknown;
        store?: any;
        writer?: (chunk: unknown) => void;
    }

    Type Parameters

    • ContextType extends Record<string, any> = Record<string, any>

    Hierarchy

    Index

    Properties

    context?: ContextType

    User provided context

    interrupt?: (value: unknown) => unknown

    Interrupts the execution of a graph node.

    This function can be used to pause execution of a node, and return the value of the resume input when the graph is re-invoked using Command. Multiple interrupts can be called within a single node, and each will be handled sequentially.

    When an interrupt is called:

    1. If there's a resume value available (from a previous Command), it returns that value.
    2. Otherwise, it throws a GraphInterrupt with the provided value
    3. The graph can be resumed by passing a Command with a resume value

    Because the interrupt function propagates by throwing a special GraphInterrupt error, you should avoid using try/catch blocks around the interrupt function, or if you do, ensure that the GraphInterrupt error is thrown again within your catch block.

    Type Declaration

      • (value: unknown): unknown
      • Parameters

        • value: unknown

          The value to include in the interrupt.

        Returns unknown

        The resume value provided when the graph is re-invoked with a Command.

    store?: any

    Persistent key-value store

    writer?: (chunk: unknown) => void

    Callback to send custom data chunks via the custom stream mode