langchain-ai/langgraphjs
1
0
Fork 0
mirror of https://github.com/langchain-ai/langgraphjs.git synced 2026-07-22 09:05:28 -04:00
Code Issues 108 Packages Projects Releases 20 Wiki Activity

Docs issue: await agent.streamEvents() is complained by TypeScript because it's not Promise #225

New Issue
Closed
opened 2026-02-15 17:17:32 -05:00 by yindo · 2 comments
yindo commented 2026-02-15 17:17:32 -05:00
Owner
Copy Link
Copy Source

Originally created by @riywo on GitHub (Apr 7, 2025).

Most of the documentation mentions like below (e.g. https://langchain-ai.github.io/langgraphjs/how-tos/stream-tokens/?h=stream+events#the-streamevents-method):

const eventStream = await agent.streamEvents(...);

This works at runtime, however, TypeScript and typescript-eslint complains like below:

Image

I guess the reason is the type definition of this function isn't Promise<>:
https://github.com/langchain-ai/langgraphjs/blob/8abd32cc53db9aaf421308361b40feeeda955ec4/libs/langgraph/src/pregel/remote.ts#L362-L367

Originally created by @riywo on GitHub (Apr 7, 2025). Most of the documentation mentions like below (e.g. https://langchain-ai.github.io/langgraphjs/how-tos/stream-tokens/?h=stream+events#the-streamevents-method): ```ts const eventStream = await agent.streamEvents(...); ``` This works at runtime, however, TypeScript and typescript-eslint complains like below: <img width="1066" alt="Image" src="https://github.com/user-attachments/assets/08ac04d5-949f-4c58-8cb9-28e77446afdf" /> I guess the reason is the type definition of this function isn't `Promise<>`: https://github.com/langchain-ai/langgraphjs/blob/8abd32cc53db9aaf421308361b40feeeda955ec4/libs/langgraph/src/pregel/remote.ts#L362-L367
yindo added the documentation label 2026-02-15 17:17:32 -05:00
yindo closed this issue 2026-02-15 17:17:32 -05:00
yindo commented 2026-02-15 17:17:34 -05:00
Author
Owner
Copy Link
Copy Source

@riywo commented on GitHub (Apr 7, 2025):

Ah, or it looks like await is not needed as TS says.

The code below works, too:

const stream = agent.streamEvents();
for await (const event of stream) {
   ...
}
@riywo commented on GitHub (Apr 7, 2025): Ah, or it looks like `await` is not needed as TS says. The code below works, too: ```ts const stream = agent.streamEvents(); for await (const event of stream) { ... } ```
yindo commented 2026-02-15 17:17:35 -05:00
Author
Owner
Copy Link
Copy Source

@benjamincburns commented on GitHub (Apr 28, 2025):

Should be addressed in documentation, indeed.

@benjamincburns commented on GitHub (Apr 28, 2025): Should be addressed in documentation, indeed.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
checkpointer
docs-needed
documentation
enhancement
good first issue
good writeup
help wanted
invalid
langgraph-supervisor
open-swe-auto
platform
prebuilt
pull-request
Mirrored from GitHub Pull Request
 question
No Label documentation
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/langgraphjs#225
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?