Skip to content

Commit e17892c

Browse files
ronagMylesBorins
authored andcommitted
doc: clarify readable.unshift null/EOF
PR-URL: #29950 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
1 parent 7ed00fd commit e17892c

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

doc/api/stream.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1288,8 +1288,10 @@ changes:
12881288
* `encoding` {string} Encoding of string chunks. Must be a valid
12891289
`Buffer` encoding, such as `'utf8'` or `'ascii'`.
12901290

1291-
Passing `chunk` as `null` signals the end of the stream (EOF), after which no
1292-
more data can be written.
1291+
Passing `chunk` as `null` signals the end of the stream (EOF) and behaves the
1292+
same as `readable.push(null)`, after which no more data can be written. The EOF
1293+
signal is put at the end of the buffer and any buffered data will still be
1294+
flushed.
12931295

12941296
The `readable.unshift()` method pushes a chunk of data back into the internal
12951297
buffer. This is useful in certain situations where a stream is being consumed by

0 commit comments

Comments
 (0)