Skip to content

Commit

Permalink
doc: make unshift doc compliant with push doc
Browse files Browse the repository at this point in the history
readable.unshift() also allows to pass null and end stream

readable.push() don't allow null when in object mode
  • Loading branch information
EduardoRFS committed Aug 4, 2019
1 parent 1592d0a commit 6bb3112
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions doc/api/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 6bb3112

Please sign in to comment.