Commit 6fc562c
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 f9f3ab2 commit 6fc562c
1 file changed
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -650,9 +650,9 @@ For both types, available `options` include: | |||
| 650 | 650 | ||
| 651 | 651 | * `onread` {Object} If specified, incoming data is stored in a single `buffer` | |
| 652 | 652 | 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 | ||
| 656 | 656 | expected. | |
| 657 | 657 | * `buffer` {Buffer|Uint8Array|Function} Either a reusable chunk of memory to | |
| 658 | 658 | use for storing incoming data or a function that returns such. | |
0 commit comments