Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 87136c9

Browse filesBrowse files
Trottaddaleax
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 <trivikr.dev@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
1 parent b470354 commit 87136c9
Copy full SHA for 87136c9

File tree

Expand file treeCollapse file tree

1 file changed

+3
-3
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+3
-3
lines changed
Open diff view settings
Collapse file

‎doc/api/net.md‎

Copy file name to clipboardExpand all lines: doc/api/net.md
+3-3Lines changed: 3 additions & 3 deletions
  • Display the source diff
  • Display the rich diff
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 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.