Skip to content

stream: rename Duplex.toWeb() type option to readableType #61632

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Renegade334 wants to merge 2 commits into
base: main
Choose a base branch
from
+41 −8
Open

stream: rename Duplex.toWeb() type option to readableType #61632

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4fdc85
stream: rename `Duplex.toWeb()` type option to `readableType`
Renegade334 Feb 2, 2026
c16967a
fixup! stream: rename `Duplex.toWeb()` type option to `readableType`
Renegade334 Feb 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions doc/api/deprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4388,6 +4388,21 @@ import { opendir } from 'node:fs/promises';
}
```

### DEP0201: Passing `options.type` to `Duplex.toWeb()`

<!-- YAML
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/61632
description: Documentation-only deprecation.
-->

Type: Documentation-only

Passing the `type` option to [`Duplex.toWeb()`][] is deprecated. To specify the
type of the readable half of the constructed readable-writable pair, use the
`readableType` option instead.

[DEP0142]: #dep0142-repl_builtinlibs
[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
[RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3
Expand All @@ -4406,6 +4421,7 @@ import { opendir } from 'node:fs/promises';
[`Buffer.isBuffer()`]: buffer.md#static-method-bufferisbufferobj
[`Cipheriv`]: crypto.md#class-cipheriv
[`Decipheriv`]: crypto.md#class-decipheriv
[`Duplex.toWeb()`]: stream.md#streamduplextowebstreamduplex-options
[`Error.isError`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/isError
[`REPLServer.clearBufferedCommand()`]: repl.md#replserverclearbufferedcommand
[`ReadStream.open()`]: fs.md#class-fsreadstream
Expand Down
13 changes: 10 additions & 3 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3219,7 +3219,8 @@ changes:
If no value is provided, the size will be `1` for all the chunks.
* `chunk` {any}
* Returns: {number}
* `type` {string} Must be 'bytes' or undefined.
* `type` {string} Specifies the type of the created `ReadableStream`. Must be
`'bytes'` or undefined.
* Returns: {ReadableStream}

### `stream.Writable.fromWeb(writableStream[, options])`
Expand Down Expand Up @@ -3398,9 +3399,13 @@ duplex.once('readable', () => console.log('readable', duplex.read()));
<!-- YAML
added: v17.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/61632
description: Added the 'readableType' option to specify the ReadableStream
type. The 'type' option is deprecated.
- version: v25.4.0
pr-url: https://github.com/nodejs/node/pull/58664
description: Add 'type' option to specify 'bytes'.
description: Added the 'type' option to specify the ReadableStream type.
- version:
- v24.0.0
- v22.17.0
Expand All @@ -3410,7 +3415,9 @@ changes:

* `streamDuplex` {stream.Duplex}
* `options` {Object}
* `type` {string} Must be 'bytes' or undefined.
* `readableType` {string} Specifies the type of the `ReadableStream` half of
the created readable-writable pair. Must be `'bytes'` or undefined.
(`options.type` is a deprecated alias for this option.)
* Returns: {Object}
* `readable` {ReadableStream}
* `writable` {WritableStream}
Expand Down
14 changes: 10 additions & 4 deletions lib/internal/webstreams/adapters.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -624,7 +624,7 @@ function newStreamReadableFromReadableStream(readableStream, options = kEmptyObj

/**
* @param {Duplex} duplex
* @param {{ type?: 'bytes' }} [options]
* @param {{ readableType?: 'bytes' }} [options]
* @returns {ReadableWritablePair}
*/
function newReadableWritablePairFromDuplex(duplex, options = kEmptyObject) {
Expand All @@ -641,9 +641,15 @@ function newReadableWritablePairFromDuplex(duplex, options = kEmptyObject) {

validateObject(options, 'options');

const readableOptions = {
__proto__: null,
// DEP0201: 'options.type' is a deprecated alias for 'options.readableType'
type: options.readableType ?? options.type,
};

if (isDestroyed(duplex)) {
const writable = new WritableStream();
const readable = new ReadableStream({ type: options.type });
const readable = new ReadableStream({ type: readableOptions.type });
writable.close();
readable.cancel();
return { readable, writable };
Expand All @@ -659,8 +665,8 @@ function newReadableWritablePairFromDuplex(duplex, options = kEmptyObject) {

const readable =
isReadable(duplex) ?
newReadableStreamFromStreamReadable(duplex, options) :
new ReadableStream({ type: options.type });
newReadableStreamFromStreamReadable(duplex, readableOptions) :
new ReadableStream({ type: readableOptions.type });

if (!isReadable(duplex))
readable.cancel();
Expand Down
6 changes: 5 additions & 1 deletion test/parallel/test-stream-duplex.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,10 +147,14 @@ process.on('exit', () => {
})
});

const { writable, readable } = Duplex.toWeb(duplex, { type: 'bytes' });
const { writable, readable } = Duplex.toWeb(duplex, { readableType: 'bytes' });
writable.getWriter().write(dataToWrite);
const data = new Uint8Array(dataToRead.length);
readable.getReader({ mode: 'byob' }).read(data).then(common.mustCall((result) => {
assert.deepStrictEqual(Buffer.from(result.value), dataToRead);
}));

// Ensure that the originally-named `options.type` still works as an alias for `options.readableType`
// `getReader({ mode: 'byob' })` throws if the underlying ReadableStream is not a byte stream
Duplex.toWeb(duplex, { type: 'bytes' }).readable.getReader({ mode: 'byob' });
}
Loading