Skip to content

docs(streaming): Add JSDoc for event and stream APIs [skip chg] - #12261

Merged
Timothee Guerin (timotheeguerin) merged 1 commit into
microsoft:mainfrom
timotheeguerin:docs/jsdoc-event-stream
Oct 16, 2026
Merged

Timothee Guerin (timotheeguerin) merged 1 commit into
microsoft:mainfrom
timotheeguerin:docs/jsdoc-event-stream

Conversation

@timotheeguerin

Copy link
Copy Markdown
Member

JavaScript consumers of the event and stream libraries currently have to read implementations to understand payload fallback, content-type metadata, and validation diagnostics.

Document how event envelopes and payloads are resolved, what stream metadata queries mean, and which diagnostics the events/SSE validation hooks report. Clarify the compiler-facing registration exports as part of the same streaming API family, without changing behavior or deprecated testing guidance.

Tracked in #12228.

@pkg-pr-new

pkg-pr-new Bot commented Oct 15, 2026

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/@typespec/events@12261
npm i https://pkg.pr.new/@typespec/sse@12261
npm i https://pkg.pr.new/@typespec/streams@12261

commit: d3dbf16

@azure-sdk-automation

azure-sdk-automation Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

You can try these changes here

🛝 Playground 🌐 Website 🛝 VSCode Extension

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Note

This error may be related to your runner configuration. You can now configure runners for Copilot code review separately from Copilot cloud agent by creating a copilot-code-review.yml file with your setup steps. Read the docs for details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants