Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: which events are proxied through createWebSocketStream #2228

Closed
wants to merge 2 commits into from
Closed

doc: which events are proxied through createWebSocketStream #2228

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
924aca6
doc: which events are proxied through createWebSocketStream
coolaj86 Jun 11, 2024
f8936a7
f: doc: duplex events
coolaj86 Jun 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion doc/ws.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -625,7 +625,15 @@ The URL of the WebSocket server. Server clients don't have this attribute.
constructor.

Returns a `Duplex` stream that allows to use the Node.js streams API on top of a
given `WebSocket`.
given `WebSocket` which emits the following events:

- `end`
- `close`
- `error`
- `readable`
- `data`
- `drain`
- `timeout`

## Environment variables

Expand Down