From 75637e686740478c198889b02315c76543ed8335 Mon Sep 17 00:00:00 2001 From: Saleem Date: Sat, 16 Nov 2019 18:13:18 -0500 Subject: [PATCH] doc: use consistent naming in stream doc Consistency of method naming referred to as readable.push several other times in transform documentation and also documented under readable, so makes sense to just stick with readable.push PR-URL: https://github.com/nodejs/node/pull/30506 Reviewed-By: Matteo Collina Reviewed-By: James M Snell --- doc/api/stream.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/api/stream.md b/doc/api/stream.md index 92871539645459..d7c8ebc266bd86 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -2554,7 +2554,7 @@ method. This will be called when there is no more written data to be consumed, but before the [`'end'`][] event is emitted signaling the end of the [`Readable`][] stream. -Within the `transform._flush()` implementation, the `readable.push()` method +Within the `transform._flush()` implementation, the `transform.push()` method may be called zero or more times, as appropriate. The `callback` function must be called when the flush operation is complete. @@ -2583,7 +2583,7 @@ methods only. All `Transform` stream implementations must provide a `_transform()` method to accept input and produce output. The `transform._transform()` implementation handles the bytes being written, computes an output, then passes -that output off to the readable portion using the `readable.push()` method. +that output off to the readable portion using the `transform.push()` method. The `transform.push()` method may be called zero or more times to generate output from a single input chunk, depending on how much is to be output @@ -2595,7 +2595,7 @@ The `callback` function must be called only when the current chunk is completely consumed. The first argument passed to the `callback` must be an `Error` object if an error occurred while processing the input or `null` otherwise. If a second argument is passed to the `callback`, it will be forwarded on to the -`readable.push()` method. In other words, the following are equivalent: +`transform.push()` method. In other words, the following are equivalent: ```js transform.prototype._transform = function(data, encoding, callback) {