Commit 17d9495
doc: make unshift doc compliant with push doc
readable.unshift() also allows to pass null and end stream
PR-URL: #28953
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>1 parent 82edebf commit 17d9495
1 file changed
Lines changed: 6 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1244,13 +1244,16 @@ changes: | |||
| 1244 | 1244 | description: The `chunk` argument can now be a `Uint8Array` instance. | |
| 1245 | 1245 | --> | |
| 1246 | 1246 | ||
| 1247 | - * `chunk` {Buffer|Uint8Array|string|any} Chunk of data to unshift onto the | ||
| 1247 | + * `chunk` {Buffer|Uint8Array|string|null|any} Chunk of data to unshift onto the | ||
| 1248 | 1248 | read queue. For streams not operating in object mode, `chunk` must be a | |
| 1249 | - string, `Buffer` or `Uint8Array`. For object mode streams, `chunk` may be | ||
| 1250 | - any JavaScript value other than `null`. | ||
| 1249 | + string, `Buffer`, `Uint8Array` or `null`. For object mode streams, `chunk` | ||
| 1250 | + may be any JavaScript value. | ||
| 1251 | 1251 | * `encoding` {string} Encoding of string chunks. Must be a valid | |
| 1252 | 1252 | `Buffer` encoding, such as `'utf8'` or `'ascii'`. | |
| 1253 | 1253 | ||
| 1254 | + Passing `chunk` as `null` signals the end of the stream (EOF), after which no | ||
| 1255 | + more data can be written. | ||
| 1256 | + | ||
| 1254 | 1257 | The `readable.unshift()` method pushes a chunk of data back into the internal | |
| 1255 | 1258 | buffer. This is useful in certain situations where a stream is being consumed by | |
| 1256 | 1259 | code that needs to "un-consume" some amount of data that it has optimistically | |
0 commit comments