From c746cd3e6987a48e4add4ed8c398907fdb6c3fe3 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Thu, 31 Mar 2022 20:12:30 -0700 Subject: [PATCH] doc: clarify recommendations in stream.md PR-URL: https://github.com/nodejs/node/pull/42555 Reviewed-By: Mestery Reviewed-By: Tierney Cyren Reviewed-By: Benjamin Gruenbaum Reviewed-By: Akhil Marsonya --- doc/api/stream.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/doc/api/stream.md b/doc/api/stream.md index fef8df8ea53b7d..a67f1c315c67c3 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -546,8 +546,8 @@ The `writable.uncork()` method flushes all data buffered since [`stream.cork()`][] was called. When using [`writable.cork()`][] and `writable.uncork()` to manage the buffering -of writes to a stream, it is recommended that calls to `writable.uncork()` be -deferred using `process.nextTick()`. Doing so allows batching of all +of writes to a stream, defer calls to `writable.uncork()` using +`process.nextTick()`. Doing so allows batching of all `writable.write()` calls that occur within a given Node.js event loop phase. ```js @@ -713,7 +713,7 @@ stop until the [`'drain'`][] event is emitted. While a stream is not draining, calls to `write()` will buffer `chunk`, and return false. Once all currently buffered chunks are drained (accepted for delivery by the operating system), the `'drain'` event will be emitted. -It is recommended that once `write()` returns false, no more chunks be written +Once `write()` returns false, do not write more chunks until the `'drain'` event is emitted. While calling `write()` on a stream that is not draining is allowed, Node.js will buffer all written chunks until maximum memory usage occurs, at which point it will abort unconditionally. @@ -873,10 +873,9 @@ to consume data from a single stream. Specifically, using a combination of `on('data')`, `on('readable')`, `pipe()`, or async iterators could lead to unintuitive behavior. -Use of the `readable.pipe()` method is recommended for most users as it has been -implemented to provide the easiest way of consuming stream data. Developers that -require more fine-grained control over the transfer and generation of data can -use the [`EventEmitter`][] and `readable.on('readable')`/`readable.read()` +`readable.pipe()` provides the easiest way to consume stream data. Developers +that require more fine-grained control over the transfer and generation of data +can use the [`EventEmitter`][] and `readable.on('readable')`/`readable.read()` or the `readable.pause()`/`readable.resume()` APIs. #### Class: `stream.Readable`