From e17892c4c77b96edf7fbc512d2af1dad36185f96 Mon Sep 17 00:00:00 2001 From: Robert Nagy Date: Wed, 16 Oct 2019 12:55:15 +0200 Subject: [PATCH] doc: clarify readable.unshift null/EOF PR-URL: https://github.com/nodejs/node/pull/29950 Reviewed-By: Matteo Collina Reviewed-By: Jeremiah Senkpiel --- 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..ef0bbb502735d3 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