summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2019-11-27 13:42:44 -0800
committerAnna Henningsen <anna@addaleax.net>2019-11-30 01:34:35 +0100
commit1b110396e7d4e4495cafe53c03022083bc1f4d83 (patch)
tree6c72e4f8991228d9f99d0ac16c048f66bb2a9e98
parentea2668d2db76beda812631d73fbcd164aee5fe02 (diff)
downloadandroid-node-v8-1b110396e7d4e4495cafe53c03022083bc1f4d83.tar.gz
android-node-v8-1b110396e7d4e4495cafe53c03022083bc1f4d83.tar.bz2
android-node-v8-1b110396e7d4e4495cafe53c03022083bc1f4d83.zip
doc: revise socket.connect() note
Edit note in about `onread` option to `socket.connect()` for clarity. PR-URL: https://github.com/nodejs/node/pull/30691 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
-rw-r--r--doc/api/net.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/api/net.md b/doc/api/net.md
index 419bc8677f..9bc9812d7c 100644
--- a/doc/api/net.md
+++ b/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.