Skip to content

Commit

Permalink
[doc] Revise WebSocket#send() docs for clarity (#2077)
Browse files Browse the repository at this point in the history
Add reference to Node.js's own related documentation about the
constraints on `Object` values.

Fixes #2076
  • Loading branch information
DLiblik authored Sep 18, 2022
1 parent 9753821 commit c22cbc9
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion doc/ws.md
Original file line number Diff line number Diff line change
Expand Up @@ -554,7 +554,9 @@ only removes listeners added with
### websocket.send(data[, options][, callback])

- `data` {Array|Number|Object|String|ArrayBuffer|Buffer|DataView|TypedArray} The
data to send.
data to send. `Object` values are only supported if they conform to the
requirements of [`Buffer.from()`][]. If those constraints are not met, a
`TypeError` is thrown.
- `options` {Object}
- `binary` {Boolean} Specifies whether `data` should be sent as a binary or
not. Default is autodetected.
Expand Down Expand Up @@ -656,6 +658,8 @@ as configured by the `maxPayload` option.
[concurrency-limit]: https://github.com/websockets/ws/issues/1202
[duplex-options]:
https://nodejs.org/api/stream.html#stream_new_stream_duplex_options
[`buffer.from()`]:
https://nodejs.org/api/buffer.html#static-method-bufferfromobject-offsetorencoding-length
[`http.request()`]:
https://nodejs.org/api/http.html#http_http_request_options_callback
[`https.request()`]:
Expand Down

0 comments on commit c22cbc9

Please sign in to comment.