From a8c218c1f44f55b5a5e3f76f668962e23844f15f Mon Sep 17 00:00:00 2001 From: James M Snell Date: Sun, 16 Mar 2025 16:42:42 -0700 Subject: [PATCH 1/9] doc: make AsyncLocalStorage snapshot and bind APIs non-experimental These have been stable for a while now --- doc/api/async_context.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/doc/api/async_context.md b/doc/api/async_context.md index 6b018bc9d4e292..222d7297a4a371 100644 --- a/doc/api/async_context.md +++ b/doc/api/async_context.md @@ -144,10 +144,12 @@ Creates a new instance of `AsyncLocalStorage`. Store is only provided within a added: - v19.8.0 - v18.16.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * `fn` {Function} The function to bind to the current execution context. * Returns: {Function} A new function that calls `fn` within the captured execution context. @@ -160,10 +162,12 @@ Binds the given function to the current execution context. added: - v19.8.0 - v18.16.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/00000 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * Returns: {Function} A new function with the signature `(fn: (...args) : R, ...args) : R`. From e64f6cc605b0682bee993847cbe4f50092314c1b Mon Sep 17 00:00:00 2001 From: James M Snell Date: Sun, 16 Mar 2025 16:51:54 -0700 Subject: [PATCH 2/9] doc: remove the experimental status for multiple web streams apis --- doc/api/globals.md | 102 ++++++++++++++++++++++++++++++--------------- 1 file changed, 68 insertions(+), 34 deletions(-) diff --git a/doc/api/globals.md b/doc/api/globals.md index 107aaf58c2e7a3..0855ad28d3fdba 100644 --- a/doc/api/globals.md +++ b/doc/api/globals.md @@ -250,10 +250,12 @@ Used to handle binary data. See the [buffer section][]. -> Stability: 1 - Experimental. - A browser-compatible implementation of [`ByteLengthQueuingStrategy`][]. ## `__dirname` @@ -339,10 +341,12 @@ with the [`--no-experimental-websocket`][] CLI flag. -> Stability: 1 - Experimental. - A browser-compatible implementation of [`CompressionStream`][]. ## `console` @@ -361,10 +365,12 @@ Used to print to stdout and stderr. See the [`console`][] section. -> Stability: 1 - Experimental. - A browser-compatible implementation of [`CountQueuingStrategy`][]. ## `Crypto` @@ -458,10 +464,12 @@ A browser-compatible implementation of the [`CustomEvent` Web API][]. -> Stability: 1 - Experimental. - A browser-compatible implementation of [`DecompressionStream`][]. ## `Event` @@ -884,60 +892,72 @@ DataHandler.prototype.load = async function load(key) { -> Stability: 1 - Experimental. - A browser-compatible implementation of [`ReadableByteStreamController`][]. ## Class: `ReadableStream` -> Stability: 1 - Experimental. - A browser-compatible implementation of [`ReadableStream`][]. ## Class: `ReadableStreamBYOBReader` -> Stability: 1 - Experimental. - A browser-compatible implementation of [`ReadableStreamBYOBReader`][]. ## Class: `ReadableStreamBYOBRequest` -> Stability: 1 - Experimental. - A browser-compatible implementation of [`ReadableStreamBYOBRequest`][]. ## Class: `ReadableStreamDefaultController` -> Stability: 1 - Experimental. - A browser-compatible implementation of [`ReadableStreamDefaultController`][]. ## Class: `ReadableStreamDefaultReader` -> Stability: 1 - Experimental. - A browser-compatible implementation of [`ReadableStreamDefaultReader`][]. ## `require()` @@ -1089,10 +1109,12 @@ The WHATWG `TextDecoder` class. See the [`TextDecoder`][] section. -> Stability: 1 - Experimental. - A browser-compatible implementation of [`TextDecoderStream`][]. ## `TextEncoder` @@ -1109,30 +1131,36 @@ The WHATWG `TextEncoder` class. See the [`TextEncoder`][] section. -> Stability: 1 - Experimental. - A browser-compatible implementation of [`TextEncoderStream`][]. ## Class: `TransformStream` -> Stability: 1 - Experimental. - A browser-compatible implementation of [`TransformStream`][]. ## Class: `TransformStreamDefaultController` -> Stability: 1 - Experimental. - A browser-compatible implementation of [`TransformStreamDefaultController`][]. ## `URL` @@ -1203,30 +1231,36 @@ with the [`--no-experimental-websocket`][] CLI flag. -> Stability: 1 - Experimental. - A browser-compatible implementation of [`WritableStream`][]. ## Class: `WritableStreamDefaultController` -> Stability: 1 - Experimental. - A browser-compatible implementation of [`WritableStreamDefaultController`][]. ## Class: `WritableStreamDefaultWriter` -> Stability: 1 - Experimental. - A browser-compatible implementation of [`WritableStreamDefaultWriter`][]. [CommonJS module]: modules.md From 17a20ed7722ea7c4dbf7cfffcf1d51f6ddabc4e9 Mon Sep 17 00:00:00 2001 From: James M Snell Date: Sun, 16 Mar 2025 16:53:50 -0700 Subject: [PATCH 3/9] doc: mark the MIMEUtil API stable --- doc/api/util.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/api/util.md b/doc/api/util.md index 8210f33a2a664b..5a0f2550fc2e91 100644 --- a/doc/api/util.md +++ b/doc/api/util.md @@ -1497,10 +1497,12 @@ equality. 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 - An implementation of [the MIMEType class](https://bmeck.github.io/node-proposal-mime-api/). In accordance with browser conventions, all properties of `MIMEType` objects From 7a7ea4248d66a8ebd211073fc92552c60db31d64 Mon Sep 17 00:00:00 2001 From: James M Snell Date: Sun, 16 Mar 2025 16:56:22 -0700 Subject: [PATCH 4/9] doc: mark tracing module stable --- doc/api/tracing.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/doc/api/tracing.md b/doc/api/tracing.md index 1b18243a5ad1d3..3d59be0dfadc1e 100644 --- a/doc/api/tracing.md +++ b/doc/api/tracing.md @@ -2,8 +2,6 @@ -> Stability: 1 - Experimental - The `node:trace_events` module provides a mechanism to centralize tracing From f086155658866f12e963e92fbef297fe958e0340 Mon Sep 17 00:00:00 2001 From: James M Snell Date: Sun, 16 Mar 2025 16:57:25 -0700 Subject: [PATCH 5/9] doc: mark transferable AbortSignal/Controller stable --- doc/api/util.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/doc/api/util.md b/doc/api/util.md index 5a0f2550fc2e91..27e9d5826d6cf8 100644 --- a/doc/api/util.md +++ b/doc/api/util.md @@ -2629,10 +2629,12 @@ Unicode "replacement character" U+FFFD. -> Stability: 1 - Experimental - Creates and returns an {AbortController} instance whose {AbortSignal} is marked as transferable and can be used with `structuredClone()` or `postMessage()`. @@ -2640,10 +2642,12 @@ as transferable and can be used with `structuredClone()` or `postMessage()`. -> Stability: 1 - Experimental - * `signal` {AbortSignal} * Returns: {AbortSignal} From ebc82863451b884def9d285d007fbeecc933dd2b Mon Sep 17 00:00:00 2001 From: James M Snell Date: Sun, 16 Mar 2025 17:06:40 -0700 Subject: [PATCH 6/9] Apply suggestions from code review --- doc/api/async_context.md | 4 ++-- doc/api/globals.md | 34 +++++++++++++++++----------------- doc/api/util.md | 6 +++--- 3 files changed, 22 insertions(+), 22 deletions(-) diff --git a/doc/api/async_context.md b/doc/api/async_context.md index 222d7297a4a371..0b158cf5a58a01 100644 --- a/doc/api/async_context.md +++ b/doc/api/async_context.md @@ -146,7 +146,7 @@ added: - v18.16.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> @@ -164,7 +164,7 @@ added: - v18.16.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> diff --git a/doc/api/globals.md b/doc/api/globals.md index 0855ad28d3fdba..8897d637be533d 100644 --- a/doc/api/globals.md +++ b/doc/api/globals.md @@ -252,7 +252,7 @@ Used to handle binary data. See the [buffer section][]. added: v18.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> @@ -343,7 +343,7 @@ with the [`--no-experimental-websocket`][] CLI flag. added: v18.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> @@ -367,7 +367,7 @@ Used to print to stdout and stderr. See the [`console`][] section. added: v18.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> @@ -466,7 +466,7 @@ A browser-compatible implementation of the [`CustomEvent` Web API][]. added: v18.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> @@ -894,7 +894,7 @@ DataHandler.prototype.load = async function load(key) { added: v18.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> @@ -906,7 +906,7 @@ A browser-compatible implementation of [`ReadableByteStreamController`][]. added: v18.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> @@ -918,7 +918,7 @@ A browser-compatible implementation of [`ReadableStream`][]. added: v18.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> @@ -930,7 +930,7 @@ A browser-compatible implementation of [`ReadableStreamBYOBReader`][]. added: v18.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> @@ -942,7 +942,7 @@ A browser-compatible implementation of [`ReadableStreamBYOBRequest`][]. added: v18.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> @@ -954,7 +954,7 @@ A browser-compatible implementation of [`ReadableStreamDefaultController`][]. added: v18.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> @@ -1111,7 +1111,7 @@ The WHATWG `TextDecoder` class. See the [`TextDecoder`][] section. added: v18.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> @@ -1133,7 +1133,7 @@ The WHATWG `TextEncoder` class. See the [`TextEncoder`][] section. added: v18.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> @@ -1145,7 +1145,7 @@ A browser-compatible implementation of [`TextEncoderStream`][]. added: v18.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> @@ -1157,7 +1157,7 @@ A browser-compatible implementation of [`TransformStream`][]. added: v18.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> @@ -1233,7 +1233,7 @@ with the [`--no-experimental-websocket`][] CLI flag. added: v18.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> @@ -1245,7 +1245,7 @@ A browser-compatible implementation of [`WritableStream`][]. added: v18.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> @@ -1257,7 +1257,7 @@ A browser-compatible implementation of [`WritableStreamDefaultController`][]. added: v18.0.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> diff --git a/doc/api/util.md b/doc/api/util.md index 27e9d5826d6cf8..1fe5c4b4f8fc2a 100644 --- a/doc/api/util.md +++ b/doc/api/util.md @@ -1499,7 +1499,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/57510 description: Marking the API stable. --> @@ -2631,7 +2631,7 @@ Unicode "replacement character" U+FFFD. added: v18.11.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> @@ -2644,7 +2644,7 @@ as transferable and can be used with `structuredClone()` or `postMessage()`. added: v18.11.0 changes: - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/00000 + pr-url: https://github.com/nodejs/node/pull/57510 description: Marking the API stable. --> From a6fb2924df2448a0aa991a32cd16b5600e5c2ff4 Mon Sep 17 00:00:00 2001 From: James M Snell Date: Sun, 16 Mar 2025 17:22:04 -0700 Subject: [PATCH 7/9] Apply suggestions from code review Co-authored-by: Antoine du Hamel --- doc/api/tracing.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/api/tracing.md b/doc/api/tracing.md index 3d59be0dfadc1e..8ef806d66619f2 100644 --- a/doc/api/tracing.md +++ b/doc/api/tracing.md @@ -4,6 +4,14 @@ + + The `node:trace_events` module provides a mechanism to centralize tracing information generated by V8, Node.js core, and userspace code. From c9847ef21b95d10ba99d0d2b56d1f9e586ae95d3 Mon Sep 17 00:00:00 2001 From: James M Snell Date: Tue, 18 Mar 2025 06:57:35 -0700 Subject: [PATCH 8/9] Update doc/api/tracing.md --- doc/api/tracing.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/tracing.md b/doc/api/tracing.md index 8ef806d66619f2..143ec16dc12a82 100644 --- a/doc/api/tracing.md +++ b/doc/api/tracing.md @@ -2,6 +2,8 @@ +> Stability: 1 - Experimental + - - The `node:trace_events` module provides a mechanism to centralize tracing information generated by V8, Node.js core, and userspace code.