diff options
| author | Robert Nagy <ronagy@icloud.com> | 2019-10-16 12:55:15 +0200 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2019-10-16 13:04:55 -0700 |
| commit | 273d38b1980fe308583c430eaeb837b8e6b3d204 (patch) | |
| tree | 3089aa87707346c73bef204da9244071cc0e60c6 /doc | |
| parent | 1599aeb08df47d7a7f23be71462dc4f80cb3dce5 (diff) | |
| download | node-new-273d38b1980fe308583c430eaeb837b8e6b3d204.tar.gz | |
doc: clarify readable.unshift null/EOF
PR-URL: https://github.com/nodejs/node/pull/29950
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/stream.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index 52d8183d8d..ef0bbb5027 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -1288,8 +1288,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 |