Add Workflow Streams documentation for the TypeScript SDK#4620
Open
brianstrauch wants to merge 8 commits into
Open
Add Workflow Streams documentation for the TypeScript SDK#4620brianstrauch wants to merge 8 commits into
brianstrauch wants to merge 8 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📖 Docs PR preview links
|
Contributor
|
I am going to take a look at the content across this and the Python pages and isolate some language neutral content out into our conceptual sections, and create sub pages as needed to reduce single page length |
Mirrors the existing Python SDK Workflow Streams page, adapted for the
TypeScript implementation in @temporalio/workflow-streams: construct at
the top of the Workflow function, `await using` for client disposal,
`{ forceFlush: true }` option syntax, `defineSignal`/`setHandler` for
the ack handshake, and `makeContinueAsNewFunc` for non-default CAN
options. Wired into the TypeScript Workflows sidebar and index.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…e for reference throughout docs
…Streams encyclopedia page
…low Streams encyclopedia page
flippedcoder
force-pushed
the
workflow-streams-typescript-docs
branch
from
2e013ce to
667bdbf
Compare
flippedcoder
reviewed
Jun 1, 2026
Contributor
There was a problem hiding this comment.
@brianstrauch Just finished splitting out some of the content to the encyclopedia and shortened the Python and TS pages. All that's left are the couple comments about the links and we can get this merged when you're ready.
|
|
||
| ## See also | ||
|
|
||
| - [Workflow Streams samples (samples-typescript)](https://github.com/temporalio/samples-typescript/tree/main/workflow-streams): runnable scenarios covering basic publish/subscribe, reconnecting subscribers, external publishers, bounded logs, and LLM streaming. |
Contributor
There was a problem hiding this comment.
@brianstrauch Is this link live yet? It's going to a 404 right now.
| ## See also | ||
|
|
||
| - [Workflow Streams samples (samples-typescript)](https://github.com/temporalio/samples-typescript/tree/main/workflow-streams): runnable scenarios covering basic publish/subscribe, reconnecting subscribers, external publishers, bounded logs, and LLM streaming. | ||
| - [`@temporalio/workflow-streams` API reference](https://typedoc.io/packages/@temporalio/workflow-streams). |
Contributor
There was a problem hiding this comment.
@brianstrauch Same question here. Is this link supposed to be live yet?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/develop/typescript/workflows/workflow-streams.mdx, a TypeScript counterpart to the existing Python Workflow Streams page.await usingfor client disposal,{ forceFlush: true }option syntax,defineSignal/setHandlerfor the ack handshake, andmakeContinueAsNewFuncfor non-default Continue-As-New options.sidebars.js) and the workflow index page.Test plan
yarn buildsucceeds (verifies frontmatter parses and intra-site anchors#continue-as-new,#closing-the-stream,#stream-llm-output,#delivery-semantics,#architecture,#tuning,#publish-from-a-clientresolve)yarn startshows "Workflow Streams" under TypeScript SDK → Workflows in the sidebar🤖 Generated with Claude Code
┆Attachments: EDU-6428 Add Workflow Streams documentation for the TypeScript SDK