diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index 78268b2b666138..bb8ca3e63e0096 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -4415,6 +4415,21 @@ import { opendir } from 'node:fs/promises'; } ``` +### DEP0201: Passing `options.type` to `Duplex.toWeb()` + + + +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 @@ -4433,6 +4448,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 diff --git a/doc/api/process.md b/doc/api/process.md index 1c04b53275516f..ec41b349c14443 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -907,7 +907,7 @@ changes: description: Change stability index for this feature from Experimental to Stable. --> -* Type: {number} +* Returns: {number} Gets the amount of free memory that is still available to the process (in bytes). @@ -1081,7 +1081,7 @@ changes: description: Aligned return value with `uv_get_constrained_memory`. --> -* Type: {number} +* Returns: {number} Gets the amount of memory available to the process (in bytes) based on limits imposed by the OS. If there is no such constraint, or the constraint diff --git a/doc/api/stream.md b/doc/api/stream.md index ef6dd51eabfd5e..73009939fe721b 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -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])` @@ -3398,9 +3399,13 @@ duplex.once('readable', () => console.log('readable', duplex.read()));