From d9d9549cbafe09942454c6b6b3cbf2cb72e96207 Mon Sep 17 00:00:00 2001 From: James M Snell Date: Sun, 16 Mar 2025 17:27:47 -0700 Subject: [PATCH 1/9] doc: mark multiple vm module APIS stable I'm guessing 5-7 years is long enough to be experimental --- doc/api/vm.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/doc/api/vm.md b/doc/api/vm.md index c7ca77fac93673..6c71bbfc63dae7 100644 --- a/doc/api/vm.md +++ b/doc/api/vm.md @@ -406,10 +406,12 @@ console.log(script.sourceMapURL); added: - v13.0.0 - v12.16.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - This feature is only available with the `--experimental-vm-modules` command flag enabled. @@ -741,10 +743,12 @@ value that is not `undefined`. -> Stability: 1 - Experimental - This feature is only available with the `--experimental-vm-modules` command flag enabled. @@ -895,10 +899,12 @@ const module2 = new vm.SourceTextModule('const a = 1;', { cachedData }); added: - v13.0.0 - v12.16.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - This feature is only available with the `--experimental-vm-modules` command flag enabled. @@ -1209,10 +1215,12 @@ using [`vm.constants.DONT_CONTEXTIFY`][]. -> Stability: 1 - Experimental - Measure the memory known to V8 and used by all contexts known to the current V8 isolate, or the main context. From 2d54292408b1ad83f0bed7fd70c43da4d9c23bed Mon Sep 17 00:00:00 2001 From: James M Snell Date: Sun, 16 Mar 2025 17:29:33 -0700 Subject: [PATCH 2/9] doc: mark worker_threads API stable --- doc/api/worker_threads.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md index 20ce83be81782d..e234584c17739d 100644 --- a/doc/api/worker_threads.md +++ b/doc/api/worker_threads.md @@ -995,10 +995,12 @@ port2.postMessage(new URL('https://example.org')); added: - v18.1.0 - v16.17.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * Returns: {boolean} If true, the `MessagePort` object will keep the Node.js event loop active. From 81e9043700149a9de9b8837064f7dd2d5a0d6ee4 Mon Sep 17 00:00:00 2001 From: James M Snell Date: Sun, 16 Mar 2025 17:30:32 -0700 Subject: [PATCH 3/9] doc: mark multiple v8 module APIs stable --- doc/api/v8.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/doc/api/v8.md b/doc/api/v8.md index 37099594a2f18c..3718c526a363ab 100644 --- a/doc/api/v8.md +++ b/doc/api/v8.md @@ -580,10 +580,12 @@ if (isMainThread) { added: - v18.10.0 - v16.18.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * `limit` {integer} The API is a no-op if `--heapsnapshot-near-heap-limit` is already set from the @@ -1116,10 +1118,12 @@ occur synchronously in the case of `Promise.resolve()` or `Promise.reject()`. added: - v18.6.0 - v16.17.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - The `v8.startupSnapshot` interface can be used to add serialization and deserialization hooks for custom startup snapshots. From 4d035fb3de40b99ebd1ef8f8f05808d6c4df18bb Mon Sep 17 00:00:00 2001 From: James M Snell Date: Sun, 16 Mar 2025 17:32:10 -0700 Subject: [PATCH 4/9] doc: mark object url APIs stable --- doc/api/buffer.md | 6 ++++-- doc/api/url.md | 12 ++++++++---- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 08756bb9ca23ae..96e363fd98c799 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -5281,10 +5281,12 @@ An alias for [`buffer.constants.MAX_STRING_LENGTH`][]. -> Stability: 1 - Experimental - * `id` {string} A `'blob:nodedata:...` URL string returned by a prior call to `URL.createObjectURL()`. * Returns: {Blob} diff --git a/doc/api/url.md b/doc/api/url.md index f6913bc688032c..c6ecfc390f73e9 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -628,10 +628,12 @@ console.log(JSON.stringify(myURLs)); -> Stability: 1 - Experimental - * `blob` {Blob} * Returns: {string} @@ -664,10 +666,12 @@ to other workers or the main thread. -> Stability: 1 - Experimental - * `id` {string} A `'blob:nodedata:...` URL string returned by a prior call to `URL.createObjectURL()`. From e3d712d4316e2f14eeada7eaba6a747b09c58f9c Mon Sep 17 00:00:00 2001 From: James M Snell Date: Sun, 16 Mar 2025 17:37:58 -0700 Subject: [PATCH 5/9] doc: mark more streams apis stable --- doc/api/stream.md | 147 ++++++++++++++++++++++++++++++---------------- 1 file changed, 97 insertions(+), 50 deletions(-) diff --git a/doc/api/stream.md b/doc/api/stream.md index e80b2e6c28df81..01ead4d996665a 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -877,10 +877,12 @@ the stream has not been destroyed, errored, or ended. added: - v18.0.0 - v16.17.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * {boolean} Returns whether the stream was destroyed or errored before emitting `'finish'`. @@ -1641,10 +1643,12 @@ the stream has not been destroyed or emitted `'error'` or `'end'`. -> Stability: 1 - Experimental - * {boolean} Returns whether the stream was destroyed or errored before emitting `'end'`. @@ -1655,10 +1659,12 @@ Returns whether the stream was destroyed or errored before emitting `'end'`. added: - v16.7.0 - v14.18.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * {boolean} Returns whether `'data'` has been emitted. @@ -2003,10 +2009,12 @@ a promise that fulfills when the stream is finished. added: - v19.1.0 - v18.13.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * `stream` {Stream|Iterable|AsyncIterable|Function} * `options` {Object} * `signal` {AbortSignal} allows destroying the stream if the signal is @@ -2038,10 +2046,12 @@ See [`stream.compose`][] for more information. -> Stability: 1 - Experimental - * `options` {Object} * `destroyOnReturn` {boolean} When set to `false`, calling `return` on the async iterator, or exiting a `for await...of` iteration using a `break`, @@ -2095,6 +2105,9 @@ added: - v17.4.0 - v16.14.0 changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. - version: - v20.7.0 - v18.19.0 @@ -2102,8 +2115,6 @@ changes: description: added `highWaterMark` in options. --> -> Stability: 1 - Experimental - * `fn` {Function|AsyncFunction} a function to map over every chunk in the stream. * `data` {any} a chunk of data from the stream. @@ -2150,6 +2161,9 @@ added: - v17.4.0 - v16.14.0 changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. - version: - v20.7.0 - v18.19.0 @@ -2157,8 +2171,6 @@ changes: description: added `highWaterMark` in options. --> -> Stability: 1 - Experimental - * `fn` {Function|AsyncFunction} a function to filter chunks from the stream. * `data` {any} a chunk of data from the stream. * `options` {Object} @@ -2208,10 +2220,12 @@ for await (const result of dnsResults) { added: - v17.5.0 - v16.15.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * `fn` {Function|AsyncFunction} a function to call on each chunk of the stream. * `data` {any} a chunk of data from the stream. * `options` {Object} @@ -2269,10 +2283,12 @@ console.log('done'); // Stream has finished added: - v17.5.0 - v16.15.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * `options` {Object} * `signal` {AbortSignal} allows cancelling the toArray operation if the signal is aborted. @@ -2309,10 +2325,12 @@ const dnsResults = await Readable.from([ added: - v17.5.0 - v16.15.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * `fn` {Function|AsyncFunction} a function to call on each chunk of the stream. * `data` {any} a chunk of data from the stream. * `options` {Object} @@ -2360,10 +2378,12 @@ console.log('done'); // Stream has finished added: - v17.5.0 - v16.17.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * `fn` {Function|AsyncFunction} a function to call on each chunk of the stream. * `data` {any} a chunk of data from the stream. * `options` {Object} @@ -2412,10 +2432,12 @@ console.log('done'); // Stream has finished added: - v17.5.0 - v16.15.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * `fn` {Function|AsyncFunction} a function to call on each chunk of the stream. * `data` {any} a chunk of data from the stream. * `options` {Object} @@ -2463,10 +2485,12 @@ console.log('done'); // Stream has finished added: - v17.5.0 - v16.15.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * `fn` {Function|AsyncGeneratorFunction|AsyncFunction} a function to map over every chunk in the stream. * `data` {any} a chunk of data from the stream. @@ -2514,10 +2538,12 @@ for await (const result of concatResult) { added: - v17.5.0 - v16.15.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * `limit` {number} the number of chunks to drop from the readable. * `options` {Object} * `signal` {AbortSignal} allows destroying the stream if the signal is @@ -2538,10 +2564,12 @@ await Readable.from([1, 2, 3, 4]).drop(2).toArray(); // [3, 4] added: - v17.5.0 - v16.15.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * `limit` {number} the number of chunks to take from the readable. * `options` {Object} * `signal` {AbortSignal} allows destroying the stream if the signal is @@ -2562,10 +2590,12 @@ await Readable.from([1, 2, 3, 4]).take(2).toArray(); // [1, 2] added: - v17.5.0 - v16.15.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * `fn` {Function|AsyncFunction} a reducer function to call over every chunk in the stream. * `previous` {any} the value obtained from the last call to `fn` or the @@ -3079,10 +3109,12 @@ Readable.from([ -> Stability: 1 - Experimental - * `readableStream` {ReadableStream} * `options` {Object} * `encoding` {string} @@ -3095,10 +3127,12 @@ added: v17.0.0 -> Stability: 1 - Experimental - * `stream` {stream.Readable|ReadableStream} * Returns: `boolean` @@ -3110,10 +3144,12 @@ Returns whether the stream has been read from or cancelled. added: - v17.3.0 - v16.14.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * `stream` {Readable|Writable|Duplex|WritableStream|ReadableStream} * Returns: {boolean} @@ -3125,10 +3161,12 @@ Returns whether the stream has encountered an error. added: - v17.4.0 - v16.14.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * `stream` {Readable|Duplex|ReadableStream} * Returns: {boolean} @@ -3139,14 +3177,15 @@ Returns whether the stream is readable. -> Stability: 1 - Experimental - * `streamReadable` {stream.Readable} * `options` {Object} * `strategy` {Object} @@ -3164,10 +3203,12 @@ changes: -> Stability: 1 - Experimental - * `writableStream` {WritableStream} * `options` {Object} * `decodeStrings` {boolean} @@ -3180,10 +3221,12 @@ added: v17.0.0 -> Stability: 1 - Experimental - * `streamWritable` {stream.Writable} * Returns: {WritableStream} @@ -3242,10 +3285,12 @@ Duplex.from([ -> Stability: 1 - Experimental - * `pair` {Object} * `readable` {ReadableStream} * `writable` {WritableStream} @@ -3323,10 +3368,12 @@ duplex.once('readable', () => console.log('readable', duplex.read())); -> Stability: 1 - Experimental - * `streamDuplex` {stream.Duplex} * Returns: {Object} * `readable` {ReadableStream} From 188edf760eb856e83d43f0b1b383b47fa4947b19 Mon Sep 17 00:00:00 2001 From: James M Snell Date: Sun, 16 Mar 2025 17:38:57 -0700 Subject: [PATCH 6/9] doc: mark readline promises api stable --- doc/api/readline.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/api/readline.md b/doc/api/readline.md index ff3e572058ffcf..6de7d33d83d6fe 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -500,10 +500,12 @@ line prompts are included in the calculations. -> Stability: 1 - Experimental - ### Class: `readlinePromises.Interface` -> Stability: 1 - Experimental - * Returns: {ReadableStream} Returns a byte-oriented `ReadableStream` that may be used to read the file's @@ -1074,6 +1075,9 @@ behavior is similar to `cp dir1/ dir2/`. -> Stability: 1 - Experimental - * `pattern` {string|string\[]} * `options` {Object} * `cwd` {string} current working directory. **Default:** `process.cwd()` @@ -3132,6 +3134,9 @@ descriptor. See [`fs.utimes()`][]. -> Stability: 1 - Experimental - * `pattern` {string|string\[]} * `options` {Object} @@ -3583,10 +3586,12 @@ Functions based on `fs.open()` exhibit this behavior as well: -> Stability: 1 - Experimental - * `path` {string|Buffer|URL} * `options` {Object} * `type` {string} An optional mime type for the blob. @@ -5682,6 +5687,9 @@ Synchronous version of [`fs.futimes()`][]. Returns `undefined`. -> Stability: 1 - Experimental - * `pattern` {string|string\[]} * `options` {Object} * `cwd` {string} current working directory. **Default:** `process.cwd()` @@ -6837,10 +6843,12 @@ added: - v21.4.0 - v20.12.0 - v18.20.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * {string} The path to the parent directory of the file this {fs.Dirent} object refers to. From 2f7f7ba94c89312b336bc3e5b519a8c0725ccd83 Mon Sep 17 00:00:00 2001 From: James M Snell Date: Thu, 20 Mar 2025 12:56:28 -0700 Subject: [PATCH 8/9] fixup! doc: mark multiple fs APIs as stable --- doc/api/buffer.md | 2 +- doc/api/fs.md | 12 +++--- doc/api/readline.md | 2 +- doc/api/stream.md | 90 ++++++++++++++++----------------------- doc/api/url.md | 4 +- doc/api/v8.md | 4 +- doc/api/vm.md | 24 ++++------- doc/api/worker_threads.md | 2 +- 8 files changed, 57 insertions(+), 83 deletions(-) diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 96e363fd98c799..0e1074a81854d0 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -5283,7 +5283,7 @@ An alias for [`buffer.constants.MAX_STRING_LENGTH`][]. added: v16.7.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> diff --git a/doc/api/fs.md b/doc/api/fs.md index 7eb72fd53b8c1c..78618afa43c4f3 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -482,7 +482,7 @@ number of bytes read is zero. added: v17.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. - version: v23.8.0 pr-url: https://github.com/nodejs/node/pull/55461 @@ -1076,7 +1076,7 @@ behavior is similar to `cp dir1/ dir2/`. added: v22.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. - version: - v23.7.0 @@ -3135,7 +3135,7 @@ descriptor. See [`fs.utimes()`][]. added: v22.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. - version: - v23.7.0 @@ -3588,7 +3588,7 @@ Functions based on `fs.open()` exhibit this behavior as well: added: v19.8.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> @@ -5688,7 +5688,7 @@ Synchronous version of [`fs.futimes()`][]. Returns `undefined`. added: v22.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. - version: - v23.7.0 @@ -6845,7 +6845,7 @@ added: - v18.20.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> diff --git a/doc/api/readline.md b/doc/api/readline.md index 6de7d33d83d6fe..5cf2d52e22f9c9 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -502,7 +502,7 @@ line prompts are included in the calculations. added: v17.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> diff --git a/doc/api/stream.md b/doc/api/stream.md index 01ead4d996665a..c4804f5fec1b53 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -879,7 +879,7 @@ added: - v16.17.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> @@ -1645,7 +1645,7 @@ the stream has not been destroyed or emitted `'error'` or `'end'`. added: v16.8.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> @@ -1661,7 +1661,7 @@ added: - v14.18.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> @@ -2011,7 +2011,7 @@ added: - v18.13.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> @@ -2048,7 +2048,7 @@ See [`stream.compose`][] for more information. added: v16.3.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> @@ -2105,9 +2105,6 @@ added: - v17.4.0 - v16.14.0 changes: - - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 - description: Marking the API stable. - version: - v20.7.0 - v18.19.0 @@ -2115,6 +2112,8 @@ changes: description: added `highWaterMark` in options. --> +> Stability: 1 - Experimental + * `fn` {Function|AsyncFunction} a function to map over every chunk in the stream. * `data` {any} a chunk of data from the stream. @@ -2161,9 +2160,6 @@ added: - v17.4.0 - v16.14.0 changes: - - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 - description: Marking the API stable. - version: - v20.7.0 - v18.19.0 @@ -2171,6 +2167,8 @@ changes: description: added `highWaterMark` in options. --> +> Stability: 1 - Experimental + * `fn` {Function|AsyncFunction} a function to filter chunks from the stream. * `data` {any} a chunk of data from the stream. * `options` {Object} @@ -2220,12 +2218,10 @@ for await (const result of dnsResults) { added: - v17.5.0 - v16.15.0 -changes: - - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 - description: Marking the API stable. --> +> Stability: 1 - Experimental + * `fn` {Function|AsyncFunction} a function to call on each chunk of the stream. * `data` {any} a chunk of data from the stream. * `options` {Object} @@ -2283,12 +2279,10 @@ console.log('done'); // Stream has finished added: - v17.5.0 - v16.15.0 -changes: - - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 - description: Marking the API stable. --> +> Stability: 1 - Experimental + * `options` {Object} * `signal` {AbortSignal} allows cancelling the toArray operation if the signal is aborted. @@ -2325,12 +2319,10 @@ const dnsResults = await Readable.from([ added: - v17.5.0 - v16.15.0 -changes: - - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 - description: Marking the API stable. --> +> Stability: 1 - Experimental + * `fn` {Function|AsyncFunction} a function to call on each chunk of the stream. * `data` {any} a chunk of data from the stream. * `options` {Object} @@ -2379,11 +2371,10 @@ added: - v17.5.0 - v16.17.0 changes: - - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 - description: Marking the API stable. --> +> Stability: 1 - Experimental + * `fn` {Function|AsyncFunction} a function to call on each chunk of the stream. * `data` {any} a chunk of data from the stream. * `options` {Object} @@ -2432,12 +2423,10 @@ console.log('done'); // Stream has finished added: - v17.5.0 - v16.15.0 -changes: - - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 - description: Marking the API stable. --> +> Stability: 1 - Experimental + * `fn` {Function|AsyncFunction} a function to call on each chunk of the stream. * `data` {any} a chunk of data from the stream. * `options` {Object} @@ -2485,12 +2474,10 @@ console.log('done'); // Stream has finished added: - v17.5.0 - v16.15.0 -changes: - - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 - description: Marking the API stable. --> +> Stability: 1 - Experimental + * `fn` {Function|AsyncGeneratorFunction|AsyncFunction} a function to map over every chunk in the stream. * `data` {any} a chunk of data from the stream. @@ -2538,12 +2525,10 @@ for await (const result of concatResult) { added: - v17.5.0 - v16.15.0 -changes: - - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 - description: Marking the API stable. --> +> Stability: 1 - Experimental + * `limit` {number} the number of chunks to drop from the readable. * `options` {Object} * `signal` {AbortSignal} allows destroying the stream if the signal is @@ -2565,11 +2550,10 @@ added: - v17.5.0 - v16.15.0 changes: - - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 - description: Marking the API stable. --> +> Stability: 1 - Experimental + * `limit` {number} the number of chunks to take from the readable. * `options` {Object} * `signal` {AbortSignal} allows destroying the stream if the signal is @@ -2590,12 +2574,10 @@ await Readable.from([1, 2, 3, 4]).take(2).toArray(); // [1, 2] added: - v17.5.0 - v16.15.0 -changes: - - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 - description: Marking the API stable. --> +> Stability: 1 - Experimental + * `fn` {Function|AsyncFunction} a reducer function to call over every chunk in the stream. * `previous` {any} the value obtained from the last call to `fn` or the @@ -3111,7 +3093,7 @@ Readable.from([ added: v17.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> @@ -3129,7 +3111,7 @@ changes: added: v16.8.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> @@ -3146,7 +3128,7 @@ added: - v16.14.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> @@ -3163,7 +3145,7 @@ added: - v16.14.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> @@ -3178,7 +3160,7 @@ Returns whether the stream is readable. added: v17.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. - version: - v18.7.0 @@ -3205,7 +3187,7 @@ changes: added: v17.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> @@ -3223,7 +3205,7 @@ changes: added: v17.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> @@ -3287,7 +3269,7 @@ Duplex.from([ added: v17.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> @@ -3370,7 +3352,7 @@ duplex.once('readable', () => console.log('readable', duplex.read())); added: v17.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> diff --git a/doc/api/url.md b/doc/api/url.md index c6ecfc390f73e9..7a4bece9a48a0b 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -630,7 +630,7 @@ console.log(JSON.stringify(myURLs)); added: v16.7.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> @@ -668,7 +668,7 @@ to other workers or the main thread. added: v16.7.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> diff --git a/doc/api/v8.md b/doc/api/v8.md index 3718c526a363ab..dd1139b1c1adb4 100644 --- a/doc/api/v8.md +++ b/doc/api/v8.md @@ -582,7 +582,7 @@ added: - v16.18.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> @@ -1120,7 +1120,7 @@ added: - v16.17.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> diff --git a/doc/api/vm.md b/doc/api/vm.md index 6c71bbfc63dae7..c7ca77fac93673 100644 --- a/doc/api/vm.md +++ b/doc/api/vm.md @@ -406,12 +406,10 @@ console.log(script.sourceMapURL); added: - v13.0.0 - v12.16.0 -changes: - - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 - description: Marking the API stable. --> +> Stability: 1 - Experimental + This feature is only available with the `--experimental-vm-modules` command flag enabled. @@ -743,12 +741,10 @@ value that is not `undefined`. +> Stability: 1 - Experimental + This feature is only available with the `--experimental-vm-modules` command flag enabled. @@ -899,12 +895,10 @@ const module2 = new vm.SourceTextModule('const a = 1;', { cachedData }); added: - v13.0.0 - v12.16.0 -changes: - - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 - description: Marking the API stable. --> +> Stability: 1 - Experimental + This feature is only available with the `--experimental-vm-modules` command flag enabled. @@ -1215,12 +1209,10 @@ using [`vm.constants.DONT_CONTEXTIFY`][]. +> Stability: 1 - Experimental + Measure the memory known to V8 and used by all contexts known to the current V8 isolate, or the main context. diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md index e234584c17739d..e9219bbea0d6e5 100644 --- a/doc/api/worker_threads.md +++ b/doc/api/worker_threads.md @@ -997,7 +997,7 @@ added: - v16.17.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57513 description: Marking the API stable. --> From 19c2bb5f8ad0018aad5aa67a396832c7f5a6944b Mon Sep 17 00:00:00 2001 From: James M Snell Date: Thu, 20 Mar 2025 15:07:28 -0700 Subject: [PATCH 9/9] Apply suggestions from code review Co-authored-by: Antoine du Hamel --- doc/api/stream.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/doc/api/stream.md b/doc/api/stream.md index c4804f5fec1b53..6806a2bf091992 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -2370,7 +2370,6 @@ console.log('done'); // Stream has finished added: - v17.5.0 - v16.17.0 -changes: --> > Stability: 1 - Experimental @@ -2549,7 +2548,6 @@ await Readable.from([1, 2, 3, 4]).drop(2).toArray(); // [3, 4] added: - v17.5.0 - v16.15.0 -changes: --> > Stability: 1 - Experimental