Skip to content
Permalink
Browse files

doc: revise socket.connect() note

Edit note in about `onread` option to `socket.connect()` for clarity.

PR-URL: #30691
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
  • Loading branch information
Trott authored and MylesBorins committed Nov 27, 2019
1 parent f9f3ab2 commit 6fc562c97c123c96ed7d90de4055c3367a71a4fc
Showing with 3 additions and 3 deletions.
  1. +3 −3 doc/api/net.md
@@ -650,9 +650,9 @@ For both types, available `options` include:
* `onread` {Object} If specified, incoming data is stored in a single `buffer`
and passed to the supplied `callback` when data arrives on the socket.
Note: this will cause the streaming functionality to not provide any data,
however events like `'error'`, `'end'`, and `'close'` will still be emitted
as normal and methods like `pause()` and `resume()` will also behave as
This will cause the streaming functionality to not provide any data.
The socket will emit events like `'error'`, `'end'`, and `'close'`
as usual. Methods like `pause()` and `resume()` will also behave as
expected.
* `buffer` {Buffer|Uint8Array|Function} Either a reusable chunk of memory to
use for storing incoming data or a function that returns such.

0 comments on commit 6fc562c

Please sign in to comment.
You can’t perform that action at this time.