From 87136c9bde8ebff235b11f8f315ad30d4030d457 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Wed, 27 Nov 2019 13:42:44 -0800 Subject: [PATCH] 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 Reviewed-By: Anna Henningsen --- doc/api/net.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/api/net.md b/doc/api/net.md index 419bc8677fabd8..9bc9812d7ca6e9 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.