Commit f1a9df7
doc: clarify fromReadable() duck-typed contract
Document that duck-typed readable inputs must provide off() in addition
to read() and on(), matching the cleanup behavior in the implementation.
Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com>
PR-URL: #63682
Backport-PR-URL: #64675
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>1 parent 3b7f4fc commit f1a9df7
1 file changed
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1443,7 +1443,7 @@ added: REPLACEME | |||
| 1443 | 1443 | > Stability: 1 - Experimental | |
| 1444 | 1444 | ||
| 1445 | 1445 | * `readable` {stream.Readable|Object} A classic Readable stream or any object | |
| 1446 | - with `read()` and `on()` methods. | ||
| 1446 | + with `read()`, `on()`, and `off()` methods. | ||
| 1447 | 1447 | * Returns: {AsyncIterable\<Uint8Array\[]>} A stream/iter async iterable source. | |
| 1448 | 1448 | ||
| 1449 | 1449 | Converts a classic Readable stream (or duck-typed equivalent) into a | |
@@ -1452,8 +1452,8 @@ stream/iter async iterable source that can be passed to [`from()`][], | |||
| 1452 | 1452 | ||
| 1453 | 1453 | If the object implements the [`toAsyncStreamable`][] protocol (as | |
| 1454 | 1454 | `stream.Readable` does), that protocol is used. Otherwise, the function | |
| 1455 | - duck-types on `read()` and `on()` (EventEmitter) and wraps the stream with | ||
| 1456 | - a batched async iterator. | ||
| 1455 | + duck-types on `read()`, `on()`, and `off()` (EventEmitter) and wraps the | ||
| 1456 | + stream with a batched async iterator. | ||
| 1457 | 1457 | ||
| 1458 | 1458 | The result is cached per instance -- calling `fromReadable()` twice with the | |
| 1459 | 1459 | same stream returns the same iterable. | |
0 commit comments