diff --git a/libs/sdk-js/package.json b/libs/sdk-js/package.json index a54ccf4c9..ca48475f8 100644 --- a/libs/sdk-js/package.json +++ b/libs/sdk-js/package.json @@ -1,6 +1,6 @@ { "name": "@langchain/langgraph-sdk", - "version": "0.0.53", + "version": "0.0.54", "description": "Client library for interacting with the LangGraph API", "type": "module", "packageManager": "yarn@1.22.19", diff --git a/libs/sdk-js/src/client.ts b/libs/sdk-js/src/client.ts index 27a7970dc..84ef3d44c 100644 --- a/libs/sdk-js/src/client.ts +++ b/libs/sdk-js/src/client.ts @@ -1022,7 +1022,12 @@ export class RunsClient< * * @param threadId The ID of the thread. * @param runId The ID of the run. - * @param options Additional options like signal, cancelOnDisconnect, and streamMode + * @param options Additional options for controlling the stream behavior: + * - signal: An AbortSignal that can be used to cancel the stream request + * - cancelOnDisconnect: When true, automatically cancels the run if the client disconnects from the stream + * - streamMode: Controls what types of events to receive from the stream (can be a single mode or array of modes) + * Must be a subset of the stream modes passed when creating the run. Background runs default to having the union of all + * stream modes enabled. * @returns An async generator yielding stream parts. */ async *joinStream(