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

doc: readable.push(undefined) in non-object mode

Browse Source 
`readable.push()` supports `undefined` in non-object mode, but it was
not previously documented.

PR-URL: https://github.com/nodejs/node/pull/18283
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
This commit is contained in:
陈刚 2018-01-22 00:58:35 +08:00 committed by Matteo Collina
parent cae4182761
commit 8b518edf11
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/api/stream.md
View File

@ -1808,6 +1808,10 @@ class SourceWrapper extends Readable {
The `readable.push()` method is intended be called only by Readable
Implementers, and only from within the `readable._read()` method.
For streams not operating in object mode, if the `chunk` parameter of
`readable.push()` is `undefined`, it will be treated as empty string or
buffer. See [`readable.push('')`][] for more information.
#### Errors While Reading
It is recommended that errors occurring during the processing of the
@ -2323,6 +2327,7 @@ contain multi-byte characters.
[`stream.uncork()`]: #stream_writable_uncork
[`stream.unpipe()`]: #stream_readable_unpipe_destination
[`stream.wrap()`]: #stream_readable_wrap_stream
[`readable.push('')`]: #stream_readable_push
[`writable.cork()`]: #stream_writable_cork
[`writable.uncork()`]: #stream_writable_uncork
[`zlib.createDeflate()`]: zlib.html#zlib_zlib_createdeflate_options