1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: make unshift doc compliant with push doc

Browse Source 
readable.unshift() also allows to pass null and end stream

PR-URL: https://github.com/nodejs/node/pull/28953
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
This commit is contained in:
EduardoRFS 2019-08-04 12:54:48 -03:00 committed by Rich Trott
parent 636dbfe787
commit 84a638484e
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/api/stream.md
View File

@ -1244,13 +1244,16 @@ changes:
description: The `chunk` argument can now be a `Uint8Array` instance. 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 read queue. For streams not operating in object mode, `chunk` must be a
string, `Buffer` or `Uint8Array`. For object mode streams, `chunk` may be string, `Buffer`, `Uint8Array` or `null`. For object mode streams, `chunk`
any JavaScript value other than `null`. may be any JavaScript value.
* `encoding` {string} Encoding of string chunks. Must be a valid * `encoding` {string} Encoding of string chunks. Must be a valid
`Buffer` encoding, such as `'utf8'` or `'ascii'`. `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 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 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 code that needs to "un-consume" some amount of data that it has optimistically