Skip to content

doc: make stability labels more consistent #57516

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.

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

Merged
merged 5 commits into from
Mar 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 0 additions & 2 deletions doc/api/assert.md
Original file line number Diff line number Diff line change
Expand Up @@ -2600,8 +2600,6 @@ changes:
description: partialDeepStrictEqual is now Stable. Previously, it had been Experimental.
-->

> Stability: 2 - Stable

* `actual` {any}
* `expected` {any}
* `message` {string|Error}
Expand Down
2 changes: 0 additions & 2 deletions doc/api/buffer.md
Original file line number Diff line number Diff line change
Expand Up @@ -5356,8 +5356,6 @@ instance.
deprecated: v6.0.0
-->

> Stability: 0 - Deprecated: Use [`Buffer.allocUnsafeSlow()`][] instead.

* `size` {integer} The desired length of the new `SlowBuffer`.

See [`Buffer.allocUnsafeSlow()`][].
Expand Down
36 changes: 4 additions & 32 deletions doc/api/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ changes:
Node.js options as well, in addition to V8 options.
-->

> Stability: 2 - Stable

All options, including V8 options, allow words to be separated by both
dashes (`-`) or underscores (`_`). For example, `--pending-deprecation` is
equivalent to `--pending_deprecation`.
Expand Down Expand Up @@ -201,8 +203,6 @@ changes:
description: Paths delimited by comma (`,`) are no longer allowed.
-->

> Stability: 2 - Stable.

This flag configures file system read permissions using
the [Permission Model][].

Expand Down Expand Up @@ -248,8 +248,6 @@ changes:
description: Paths delimited by comma (`,`) are no longer allowed.
-->

> Stability: 2 - Stable.

This flag configures file system write permissions using
the [Permission Model][].

Expand Down Expand Up @@ -457,8 +455,6 @@ changes:
description: The flag is no longer experimental.
-->

> Stability: 2 - Stable

Provide custom [conditional exports][] resolution conditions.

Any number of custom string condition names are permitted.
Expand All @@ -484,8 +480,6 @@ changes:
description: The `--cpu-prof` flags are now stable.
-->

> Stability: 2 - Stable

Starts the V8 CPU profiler on start up, and writes the CPU profile to disk
before exit.

Expand Down Expand Up @@ -522,8 +516,6 @@ changes:
description: The `--cpu-prof` flags are now stable.
-->

> Stability: 2 - Stable

Specify the directory where the CPU profiles generated by `--cpu-prof` will
be placed.

Expand All @@ -542,8 +534,6 @@ changes:
description: The `--cpu-prof` flags are now stable.
-->

> Stability: 2 - Stable

Specify the sampling interval in microseconds for the CPU profiles generated
by `--cpu-prof`. The default is 1000 microseconds.

Expand All @@ -559,8 +549,6 @@ changes:
description: The `--cpu-prof` flags are now stable.
-->

> Stability: 2 - Stable

Specify the file name of the CPU profile generated by `--cpu-prof`.

### `--diagnostic-dir=directory`
Expand Down Expand Up @@ -1299,8 +1287,6 @@ changes:
description: The `--heap-prof` flags are now stable.
-->

> Stability: 2 - Stable

Starts the V8 heap profiler on start up, and writes the heap profile to disk
before exit.

Expand Down Expand Up @@ -1328,8 +1314,6 @@ changes:
description: The `--heap-prof` flags are now stable.
-->

> Stability: 2 - Stable

Specify the directory where the heap profiles generated by `--heap-prof` will
be placed.

Expand All @@ -1348,8 +1332,6 @@ changes:
description: The `--heap-prof` flags are now stable.
-->

> Stability: 2 - Stable

Specify the average sampling interval in bytes for the heap profiles generated
by `--heap-prof`. The default is 512 \* 1024 bytes.

Expand All @@ -1365,8 +1347,6 @@ changes:
description: The `--heap-prof` flags are now stable.
-->

> Stability: 2 - Stable

Specify the file name of the heap profile generated by `--heap-prof`.

### `--heapsnapshot-near-heap-limit=max_count`
Expand Down Expand Up @@ -1699,8 +1679,6 @@ requiring a native C++ addon will fail and throw an exception.
added: REPLACEME
-->

> Stability: 2 - Stable

Disables the use of [`AsyncLocalStorage`][] backed by `AsyncContextFrame` and
uses the prior implementation which relied on async\_hooks. The previous model
is retained for compatibility with Electron and for cases where the context
Expand Down Expand Up @@ -1932,8 +1910,6 @@ changes:
description: Permission Model is now stable.
-->

> Stability: 2 - Stable.

Enable the Permission Model for current process. When enabled, the
following permissions are restricted:

Expand Down Expand Up @@ -2248,8 +2224,6 @@ changes:
`PATH` environment variable accordingly.
-->

> Stability: 2 - Stable

This runs a specified command from a package.json's `"scripts"` object.
If a missing `"command"` is provided, it will list the available scripts.

Expand Down Expand Up @@ -3057,8 +3031,6 @@ changes:
description: Test runner now supports running in watch mode.
-->

> Stability: 2 - Stable

Starts Node.js in watch mode.
When in watch mode, changes in the watched files cause the Node.js process to
restart.
Expand Down Expand Up @@ -3087,8 +3059,6 @@ changes:
description: Watch mode is now stable.
-->

> Stability: 2 - Stable

Starts Node.js in watch mode and specifies what paths to watch.
When in watch mode, changes in the watched paths cause the Node.js process to
restart.
Expand Down Expand Up @@ -3131,6 +3101,8 @@ instances.

## Environment variables

> Stability: 2 - Stable

### `FORCE_COLOR=[1, 2, 3]`

The `FORCE_COLOR` environment variable is used to
Expand Down
12 changes: 0 additions & 12 deletions doc/api/diagnostics_channel.md
Original file line number Diff line number Diff line change
Expand Up @@ -635,8 +635,6 @@ added:
- v18.19.0
-->

> Stability: 1 - Experimental

* `subscribers` {Object} Set of [TracingChannel Channels][] subscribers
* `start` {Function} The [`start` event][] subscriber
* `end` {Function} The [`end` event][] subscriber
Expand Down Expand Up @@ -704,8 +702,6 @@ added:
- v18.19.0
-->

> Stability: 1 - Experimental

* `subscribers` {Object} Set of [TracingChannel Channels][] subscribers
* `start` {Function} The [`start` event][] subscriber
* `end` {Function} The [`end` event][] subscriber
Expand Down Expand Up @@ -775,8 +771,6 @@ added:
- v18.19.0
-->

> Stability: 1 - Experimental

* `fn` {Function} Function to wrap a trace around
* `context` {Object} Shared object to correlate events through
* `thisArg` {any} The receiver to be used for the function call
Expand Down Expand Up @@ -826,8 +820,6 @@ added:
- v18.19.0
-->

> Stability: 1 - Experimental

* `fn` {Function} Promise-returning function to wrap a trace around
* `context` {Object} Shared object to correlate trace events through
* `thisArg` {any} The receiver to be used for the function call
Expand Down Expand Up @@ -880,8 +872,6 @@ added:
- v18.19.0
-->

> Stability: 1 - Experimental

* `fn` {Function} callback using function to wrap a trace around
* `position` {number} Zero-indexed argument position of expected callback
(defaults to last argument if `undefined` is passed)
Expand Down Expand Up @@ -985,8 +975,6 @@ added:
- v20.13.0
-->

> Stability: 1 - Experimental

* Returns: {boolean} `true` if any of the individual channels has a subscriber,
`false` if not.

Expand Down
4 changes: 0 additions & 4 deletions doc/api/esm.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,8 +279,6 @@ changes:
description: Switch from Import Assertions to Import Attributes.
-->

> Stability: 2 - Stable

[Import attributes][Import Attributes MDN] are an inline syntax for module import
statements to pass on more information alongside the module specifier.

Expand Down Expand Up @@ -648,8 +646,6 @@ changes:
description: JSON modules are no longer experimental.
-->

> Stability: 2 - Stable

JSON files can be referenced by `import`:

```js
Expand Down
4 changes: 0 additions & 4 deletions doc/api/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -2444,8 +2444,6 @@ changes:
description: No longer behind `--experimental-global-customevent` CLI flag.
-->

> Stability: 2 - Stable

* Extends: {Event}

The `CustomEvent` object is an adaptation of the [`CustomEvent` Web API][].
Expand All @@ -2465,8 +2463,6 @@ changes:
description: CustomEvent is now stable.
-->

> Stability: 2 - Stable

* Type: {any} Returns custom data passed when initializing.

Read-only.
Expand Down
Loading
Loading