diff --git a/doc/api/stream.md b/doc/api/stream.md index 4cb9907202a3fe..08bdaf0df2b858 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -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