feat(res): add res.sse() for Server-Sent Events#1
Merged
Conversation
Add a res.sse() helper that opens a text/event-stream response and returns a stream with send(), stream(), comment() and close(). send() serializes data like the rest of the framework (strings as-is, Buffer/TypedArray as UTF-8, objects as JSON) and supports event/id/retry. stream() emits one event per chunk of any web ReadableStream, Node Readable, Blob or async iterable, unifying them into a Node Readable (web streams and Blobs via Readable.fromWeb(), Node streams and async iterables directly). A keep-alive heartbeat is started by default and cleared automatically on disconnect via on-finished. No new dependencies are added.
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
1 participant
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.
Add a res.sse() helper that opens a text/event-stream response and returns a stream with send(), stream(), comment() and close().
send() serializes data like the rest of the framework (strings as-is, Buffer/TypedArray as UTF-8, objects as JSON) and supports event/id/retry. stream() emits one event per chunk of any web ReadableStream, Node Readable, Blob or async iterable, unifying them into a Node Readable (web streams and Blobs via Readable.fromWeb(), Node streams and async iterables directly).
A keep-alive heartbeat is started by default and cleared automatically on disconnect via on-finished. No new dependencies are added.