Skip to content
Permalink
Browse files

doc: clarify readable.unshift null/EOF

PR-URL: #29950
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
  • Loading branch information
ronag authored and targos committed Oct 16, 2019
1 parent 45c5ad7 commit 5616f22839784d7271b39f6c78735a47ea690784
Showing with 4 additions and 2 deletions.
  1. +4 −2 doc/api/stream.md
@@ -1284,8 +1284,10 @@ changes:
* `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.
Passing `chunk` as `null` signals the end of the stream (EOF) and behaves the
same as `readable.push(null)`, after which no more data can be written. The EOF
signal is put at the end of the buffer and any buffered data will still be
flushed.

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

0 comments on commit 5616f22

Please sign in to comment.
You can’t perform that action at this time.