Skip to content

doc: mark multiple long-time experimental APIs as stable #57510

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

Closed
jasnell wants to merge 9 commits into from
Closed

doc: mark multiple long-time experimental APIs as stable #57510

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a8c218c
doc: make AsyncLocalStorage snapshot and bind APIs non-experimental
jasnell Mar 16, 2025
e64f6cc
doc: remove the experimental status for multiple web streams apis
jasnell Mar 16, 2025
17a20ed
doc: mark the MIMEUtil API stable
jasnell Mar 16, 2025
7a7ea42
doc: mark tracing module stable
jasnell Mar 16, 2025
f086155
doc: mark transferable AbortSignal/Controller stable
jasnell Mar 16, 2025
ebc8286
Apply suggestions from code review
jasnell Mar 17, 2025
a6fb292
Apply suggestions from code review
jasnell Mar 17, 2025
c9847ef
Update doc/api/tracing.md
jasnell Mar 18, 2025
9c3d8b5
Update doc/api/tracing.md
jasnell Mar 18, 2025
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
12 changes: 8 additions & 4 deletions doc/api/async_context.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,10 +144,12 @@
added:
- v19.8.0
- v18.16.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000

Check warning on line 149 in doc/api/async_context.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
Comment thread
jasnell marked this conversation as resolved.
Outdated
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.
Expand All @@ -160,10 +162,12 @@
added:
- v19.8.0
- v18.16.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000

Check warning on line 167 in doc/api/async_context.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
Comment thread
jasnell marked this conversation as resolved.
Outdated
description: Marking the API stable.
-->

> Stability: 1 - Experimental

* Returns: {Function} A new function with the signature
`(fn: (...args) : R, ...args) : R`.

Expand Down
102 changes: 68 additions & 34 deletions doc/api/globals.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,10 +250,12 @@

<!-- YAML
added: v18.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000

Check warning on line 255 in doc/api/globals.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
Comment thread
jasnell marked this conversation as resolved.
Outdated
description: Marking the API stable.
-->

> Stability: 1 - Experimental.

A browser-compatible implementation of [`ByteLengthQueuingStrategy`][].

## `__dirname`
Expand Down Expand Up @@ -339,10 +341,12 @@

<!-- YAML
added: v18.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000

Check warning on line 346 in doc/api/globals.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
Comment thread
jasnell marked this conversation as resolved.
Outdated
description: Marking the API stable.
-->

> Stability: 1 - Experimental.

A browser-compatible implementation of [`CompressionStream`][].

## `console`
Expand All @@ -361,10 +365,12 @@

<!-- YAML
added: v18.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000

Check warning on line 370 in doc/api/globals.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
Comment thread
jasnell marked this conversation as resolved.
Outdated
description: Marking the API stable.
-->

> Stability: 1 - Experimental.

A browser-compatible implementation of [`CountQueuingStrategy`][].

## `Crypto`
Expand Down Expand Up @@ -458,10 +464,12 @@

<!-- YAML
added: v18.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000

Check warning on line 469 in doc/api/globals.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
Comment thread
jasnell marked this conversation as resolved.
Outdated
description: Marking the API stable.
-->

> Stability: 1 - Experimental.

A browser-compatible implementation of [`DecompressionStream`][].

## `Event`
Expand Down Expand Up @@ -884,60 +892,72 @@

<!-- YAML
added: v18.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000

Check warning on line 897 in doc/api/globals.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
Comment thread
jasnell marked this conversation as resolved.
Outdated
description: Marking the API stable.
-->

> Stability: 1 - Experimental.

A browser-compatible implementation of [`ReadableByteStreamController`][].

## Class: `ReadableStream`

<!-- YAML
added: v18.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000

Check warning on line 909 in doc/api/globals.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
Comment thread
jasnell marked this conversation as resolved.
Outdated
description: Marking the API stable.
-->

> Stability: 1 - Experimental.

A browser-compatible implementation of [`ReadableStream`][].

## Class: `ReadableStreamBYOBReader`

<!-- YAML
added: v18.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000

Check warning on line 921 in doc/api/globals.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
Comment thread
jasnell marked this conversation as resolved.
Outdated
description: Marking the API stable.
-->

> Stability: 1 - Experimental.

A browser-compatible implementation of [`ReadableStreamBYOBReader`][].

## Class: `ReadableStreamBYOBRequest`

<!-- YAML
added: v18.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000

Check warning on line 933 in doc/api/globals.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
Comment thread
jasnell marked this conversation as resolved.
Outdated
description: Marking the API stable.
-->

> Stability: 1 - Experimental.

A browser-compatible implementation of [`ReadableStreamBYOBRequest`][].

## Class: `ReadableStreamDefaultController`

<!-- YAML
added: v18.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000
Comment thread
jasnell marked this conversation as resolved.
Outdated
description: Marking the API stable.
-->

> Stability: 1 - Experimental.

A browser-compatible implementation of [`ReadableStreamDefaultController`][].

## Class: `ReadableStreamDefaultReader`

<!-- YAML
added: v18.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000
Comment thread
jasnell marked this conversation as resolved.
Outdated
description: Marking the API stable.
-->

> Stability: 1 - Experimental.

A browser-compatible implementation of [`ReadableStreamDefaultReader`][].

## `require()`
Expand Down Expand Up @@ -1089,10 +1109,12 @@

<!-- YAML
added: v18.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000
Comment thread
jasnell marked this conversation as resolved.
Outdated
description: Marking the API stable.
-->

> Stability: 1 - Experimental.

A browser-compatible implementation of [`TextDecoderStream`][].

## `TextEncoder`
Expand All @@ -1109,30 +1131,36 @@

<!-- YAML
added: v18.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000
Comment thread
jasnell marked this conversation as resolved.
Outdated
description: Marking the API stable.
-->

> Stability: 1 - Experimental.

A browser-compatible implementation of [`TextEncoderStream`][].

## Class: `TransformStream`

<!-- YAML
added: v18.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000
Comment thread
jasnell marked this conversation as resolved.
Outdated
description: Marking the API stable.
-->

> Stability: 1 - Experimental.

A browser-compatible implementation of [`TransformStream`][].

## Class: `TransformStreamDefaultController`

<!-- YAML
added: v18.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000
Comment thread
jasnell marked this conversation as resolved.
Outdated
description: Marking the API stable.
-->

> Stability: 1 - Experimental.

A browser-compatible implementation of [`TransformStreamDefaultController`][].

## `URL`
Expand Down Expand Up @@ -1203,30 +1231,36 @@

<!-- YAML
added: v18.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000
Comment thread
jasnell marked this conversation as resolved.
Outdated
description: Marking the API stable.
-->

> Stability: 1 - Experimental.

A browser-compatible implementation of [`WritableStream`][].

## Class: `WritableStreamDefaultController`

<!-- YAML
added: v18.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000
Comment thread
jasnell marked this conversation as resolved.
Outdated
description: Marking the API stable.
-->

> Stability: 1 - Experimental.

A browser-compatible implementation of [`WritableStreamDefaultController`][].

## Class: `WritableStreamDefaultWriter`

<!-- YAML
added: v18.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000
Comment thread
jasnell marked this conversation as resolved.
Outdated
description: Marking the API stable.
-->

> Stability: 1 - Experimental.

A browser-compatible implementation of [`WritableStreamDefaultWriter`][].

[CommonJS module]: modules.md
Expand Down
2 changes: 0 additions & 2 deletions doc/api/tracing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

<!--introduced_in=v7.7.0-->

Comment thread
jasnell marked this conversation as resolved.
> Stability: 1 - Experimental
Comment thread
legendecas marked this conversation as resolved.

<!-- source_link=lib/trace_events.js -->
Comment thread
jasnell marked this conversation as resolved.

The `node:trace_events` module provides a mechanism to centralize tracing
Expand Down
18 changes: 12 additions & 6 deletions doc/api/util.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1497,10 +1497,12 @@ equality.
added:
- v19.1.0
- v18.13.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000
Comment thread
jasnell marked this conversation as resolved.
Outdated
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
Expand Down Expand Up @@ -2627,21 +2629,25 @@ Unicode "replacement character" U+FFFD.

<!-- YAML
added: v18.11.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000
Comment thread
jasnell marked this conversation as resolved.
Outdated
description: Marking the API stable.
-->

> Stability: 1 - Experimental

Creates and returns an {AbortController} instance whose {AbortSignal} is marked
as transferable and can be used with `structuredClone()` or `postMessage()`.

## `util.transferableAbortSignal(signal)`

<!-- YAML
added: v18.11.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000
Comment thread
jasnell marked this conversation as resolved.
Outdated
description: Marking the API stable.
-->

> Stability: 1 - Experimental

* `signal` {AbortSignal}
* Returns: {AbortSignal}

Expand Down
Loading
⚡