UNPKG

@langchain/langgraph-checkpoint

Version:

Library with base interfaces for LangGraph checkpoint savers.

50 lines (49 loc) 1.77 kB
export declare const TASKS = "__pregel_tasks"; export declare const ERROR = "__error__"; export declare const SCHEDULED = "__scheduled__"; export declare const INTERRUPT = "__interrupt__"; export declare const RESUME = "__resume__"; export interface ChannelProtocol<ValueType = unknown, UpdateType = unknown, CheckpointType = unknown> { ValueType: ValueType; UpdateType: UpdateType; /** * The name of the channel. */ lc_graph_name: string; /** * Return a new identical channel, optionally initialized from a checkpoint. * Can be thought of as a "restoration" from a checkpoint which is a "snapshot" of the channel's state. * * @param {CheckpointType | undefined} checkpoint * @param {CheckpointType | undefined} initialValue * @returns {this} */ fromCheckpoint(checkpoint?: CheckpointType): this; /** * Update the channel's value with the given sequence of updates. * The order of the updates in the sequence is arbitrary. * * @throws {InvalidUpdateError} if the sequence of updates is invalid. * @param {Array<UpdateType>} values * @returns {void} */ update(values: UpdateType[]): void; /** * Return the current value of the channel. * * @throws {EmptyChannelError} if the channel is empty (never updated yet). * @returns {ValueType} */ get(): ValueType; /** * Return a string representation of the channel's current state. * * @throws {EmptyChannelError} if the channel is empty (never updated yet), or doesn't support checkpoints. * @returns {CheckpointType | undefined} */ checkpoint(): CheckpointType | undefined; } export interface SendProtocol { node: string; args: any; }