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]>
nodejs · Nov 30, 2019 · 87136c9 · 87136c9
1 parent b470354
commit 87136c9
Showing 1 changed file with 3 additions and 3 deletions.
diff --git 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.