Skip to content

Commit 44b474d

Browse files
Trotttargos
authored andcommitted
doc: revise socket.connect() note
Edit note in about `onread` option to `socket.connect()` for clarity. PR-URL: #30691 Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
1 parent a2ef669 commit 44b474d

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/api/net.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -650,9 +650,9 @@ For both types, available `options` include:
650650

651651
* `onread` {Object} If specified, incoming data is stored in a single `buffer`
652652
and passed to the supplied `callback` when data arrives on the socket.
653-
Note: this will cause the streaming functionality to not provide any data,
654-
however events like `'error'`, `'end'`, and `'close'` will still be emitted
655-
as normal and methods like `pause()` and `resume()` will also behave as
653+
This will cause the streaming functionality to not provide any data.
654+
The socket will emit events like `'error'`, `'end'`, and `'close'`
655+
as usual. Methods like `pause()` and `resume()` will also behave as
656656
expected.
657657
* `buffer` {Buffer|Uint8Array|Function} Either a reusable chunk of memory to
658658
use for storing incoming data or a function that returns such.

0 commit comments

Comments
 (0)