From 4f73edfd63bff51a3282aeee4a268d6c7c0e03c8 Mon Sep 17 00:00:00 2001 From: Robert Nagy Date: Wed, 16 Oct 2019 12:55:15 +0200 Subject: [PATCH 1/2] stream: clearify readable.unshift null --- doc/api/stream.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/api/stream.md b/doc/api/stream.md index 52d8183d8ddbc1..91486408e8d176 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. Note +that 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 From e1845204a589196769a8635a4da1138f66c2e495 Mon Sep 17 00:00:00 2001 From: Robert Nagy Date: Wed, 16 Oct 2019 20:39:49 +0200 Subject: [PATCH 2/2] doc: clarify unshift EOF --- doc/api/stream.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/api/stream.md b/doc/api/stream.md index 91486408e8d176..ef0bbb502735d3 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -1289,9 +1289,9 @@ changes: `Buffer` encoding, such as `'utf8'` or `'ascii'`. 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. Note -that the EOF signal is put at the end of the buffer and any buffered data will -still be flushed. +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