From 6bb3112968c3a8eaef36897bdf156972477493aa Mon Sep 17 00:00:00 2001 From: EduardoRFS Date: Sun, 4 Aug 2019 12:54:48 -0300 Subject: [PATCH] doc: make unshift doc compliant with push doc readable.unshift() also allows to pass null and end stream readable.push() don't allow null when in object mode --- doc/api/stream.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/api/stream.md b/doc/api/stream.md index c7b00f983d83ac..770cc24956ef2a 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -1244,13 +1244,15 @@ changes: description: The `chunk` argument can now be a `Uint8Array` instance. --> -* `chunk` {Buffer|Uint8Array|string|any} Chunk of data to unshift onto the +* `chunk` {Buffer|Uint8Array|string|null|any} Chunk of data to unshift onto the read queue. For streams not operating in object mode, `chunk` must be a string, `Buffer` or `Uint8Array`. For object mode streams, `chunk` may be any JavaScript value other than `null`. * `encoding` {string} Encoding of string chunks. Must be a valid `Buffer` encoding, such as `'utf8'` or `'ascii'`. +Passing chunk as null signals the end of the stream (EOF), after which no more data can be written. + The `readable.unshift()` method pushes a chunk of data back into the internal buffer. This is useful in certain situations where a stream is being consumed by code that needs to "un-consume" some amount of data that it has optimistically @@ -2028,7 +2030,7 @@ changes: * `chunk` {Buffer|Uint8Array|string|null|any} Chunk of data to push into the read queue. For streams not operating in object mode, `chunk` must be a string, `Buffer` or `Uint8Array`. For object mode streams, `chunk` may be - any JavaScript value. + any JavaScript value other than `null`.. * `encoding` {string} Encoding of string chunks. Must be a valid `Buffer` encoding, such as `'utf8'` or `'ascii'`. * Returns: {boolean} `true` if additional chunks of data may continue to be