Skip to content

doc: mark more long-time experimental APIs as stable #57513

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

Closed
wants to merge 9 commits into from
Closed
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
6 changes: 4 additions & 2 deletions doc/api/buffer.md
Original file line number Diff line number Diff line change
Expand Up @@ -5281,10 +5281,12 @@ An alias for [`buffer.constants.MAX_STRING_LENGTH`][].

<!-- YAML
added: v16.7.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/57513
description: Marking the API stable.
-->

> Stability: 1 - Experimental

* `id` {string} A `'blob:nodedata:...` URL string returned by a prior call to
`URL.createObjectURL()`.
* Returns: {Blob}
Expand Down
32 changes: 20 additions & 12 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -481,6 +481,9 @@ number of bytes read is zero.
<!-- YAML
added: v17.0.0
changes:
- version: REPLACEME
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
description: Removed option to create a 'bytes' stream. Streams are now always 'bytes' streams.
Expand All @@ -491,8 +494,6 @@ changes:
description: Added option to create a 'bytes' stream.
-->

> Stability: 1 - Experimental

* Returns: {ReadableStream}

Returns a byte-oriented `ReadableStream` that may be used to read the file's
Expand Down Expand Up @@ -1074,6 +1075,9 @@ behavior is similar to `cp dir1/ dir2/`.
<!-- YAML
added: v22.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/57513
description: Marking the API stable.
- version:
- v23.7.0
- v22.14.0
Expand All @@ -1084,8 +1088,6 @@ changes:
description: Add support for `withFileTypes` as an option.
-->

> Stability: 1 - Experimental

* `pattern` {string|string\[]}
* `options` {Object}
* `cwd` {string} current working directory. **Default:** `process.cwd()`
Expand Down Expand Up @@ -3132,6 +3134,9 @@ descriptor. See [`fs.utimes()`][].
<!-- YAML
added: v22.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/57513
description: Marking the API stable.
- version:
- v23.7.0
- v22.14.0
Expand All @@ -3142,8 +3147,6 @@ changes:
description: Add support for `withFileTypes` as an option.
-->

> Stability: 1 - Experimental

* `pattern` {string|string\[]}

* `options` {Object}
Expand Down Expand Up @@ -3583,10 +3586,12 @@ Functions based on `fs.open()` exhibit this behavior as well:

<!-- YAML
added: v19.8.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/57513
description: Marking the API stable.
-->

> Stability: 1 - Experimental

* `path` {string|Buffer|URL}
* `options` {Object}
* `type` {string} An optional mime type for the blob.
Expand Down Expand Up @@ -5682,6 +5687,9 @@ Synchronous version of [`fs.futimes()`][]. Returns `undefined`.
<!-- YAML
added: v22.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/57513
description: Marking the API stable.
- version:
- v23.7.0
- v22.14.0
Expand All @@ -5692,8 +5700,6 @@ changes:
description: Add support for `withFileTypes` as an option.
-->

> Stability: 1 - Experimental

* `pattern` {string|string\[]}
* `options` {Object}
* `cwd` {string} current working directory. **Default:** `process.cwd()`
Expand Down Expand Up @@ -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/57513
description: Marking the API stable.
-->

> Stability: 1 - Experimental

* {string}

The path to the parent directory of the file this {fs.Dirent} object refers to.
Expand Down
6 changes: 4 additions & 2 deletions doc/api/readline.md
Original file line number Diff line number Diff line change
Expand Up @@ -500,10 +500,12 @@ line prompts are included in the calculations.

<!-- YAML
added: v17.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/57513
description: Marking the API stable.
-->

> Stability: 1 - Experimental

### Class: `readlinePromises.Interface`

<!-- YAML
Expand Down
83 changes: 55 additions & 28 deletions doc/api/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/57513
description: Marking the API stable.
-->

> Stability: 1 - Experimental

* {boolean}

Returns whether the stream was destroyed or errored before emitting `'finish'`.
Expand Down Expand Up @@ -1641,10 +1643,12 @@ the stream has not been destroyed or emitted `'error'` or `'end'`.

<!-- YAML
added: v16.8.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/57513
description: Marking the API stable.
-->

> Stability: 1 - Experimental

* {boolean}

Returns whether the stream was destroyed or errored before emitting `'end'`.
Expand All @@ -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/57513
description: Marking the API stable.
-->

> Stability: 1 - Experimental

* {boolean}

Returns whether `'data'` has been emitted.
Expand Down Expand Up @@ -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/57513
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
Expand Down Expand Up @@ -2038,10 +2046,12 @@ See [`stream.compose`][] for more information.

<!-- YAML
added: v16.3.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/57513
description: Marking the API stable.
-->

> 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`,
Expand Down Expand Up @@ -3079,10 +3089,12 @@ Readable.from([

<!-- YAML
added: v17.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/57513
description: Marking the API stable.
-->

> Stability: 1 - Experimental

* `readableStream` {ReadableStream}
* `options` {Object}
* `encoding` {string}
Expand All @@ -3095,10 +3107,12 @@ added: v17.0.0

<!-- YAML
added: v16.8.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/57513
description: Marking the API stable.
-->

> Stability: 1 - Experimental

* `stream` {stream.Readable|ReadableStream}
* Returns: `boolean`

Expand All @@ -3110,10 +3124,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/57513
description: Marking the API stable.
-->

> Stability: 1 - Experimental

* `stream` {Readable|Writable|Duplex|WritableStream|ReadableStream}
* Returns: {boolean}

Expand All @@ -3125,10 +3141,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/57513
description: Marking the API stable.
-->

> Stability: 1 - Experimental

* `stream` {Readable|Duplex|ReadableStream}
* Returns: {boolean}

Expand All @@ -3139,14 +3157,15 @@ Returns whether the stream is readable.
<!-- YAML
added: v17.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/57513
description: Marking the API stable.
- version:
- v18.7.0
pr-url: https://github.com/nodejs/node/pull/43515
description: include strategy options on Readable.
-->

> Stability: 1 - Experimental

* `streamReadable` {stream.Readable}
* `options` {Object}
* `strategy` {Object}
Expand All @@ -3164,10 +3183,12 @@ changes:

<!-- YAML
added: v17.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/57513
description: Marking the API stable.
-->

> Stability: 1 - Experimental

* `writableStream` {WritableStream}
* `options` {Object}
* `decodeStrings` {boolean}
Expand All @@ -3180,10 +3201,12 @@ added: v17.0.0

<!-- YAML
added: v17.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/57513
description: Marking the API stable.
-->

> Stability: 1 - Experimental

* `streamWritable` {stream.Writable}
* Returns: {WritableStream}

Expand Down Expand Up @@ -3242,10 +3265,12 @@ Duplex.from([

<!-- YAML
added: v17.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/57513
description: Marking the API stable.
-->

> Stability: 1 - Experimental

* `pair` {Object}
* `readable` {ReadableStream}
* `writable` {WritableStream}
Expand Down Expand Up @@ -3323,10 +3348,12 @@ duplex.once('readable', () => console.log('readable', duplex.read()));

<!-- YAML
added: v17.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/57513
description: Marking the API stable.
-->

> Stability: 1 - Experimental

* `streamDuplex` {stream.Duplex}
* Returns: {Object}
* `readable` {ReadableStream}
Expand Down
12 changes: 8 additions & 4 deletions doc/api/url.md
Original file line number Diff line number Diff line change
Expand Up @@ -628,10 +628,12 @@ console.log(JSON.stringify(myURLs));

<!-- YAML
added: v16.7.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/57513
description: Marking the API stable.
-->

> Stability: 1 - Experimental

* `blob` {Blob}
* Returns: {string}

Expand Down Expand Up @@ -664,10 +666,12 @@ to other workers or the main thread.

<!-- YAML
added: v16.7.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/57513
description: Marking the API stable.
-->

> Stability: 1 - Experimental

* `id` {string} A `'blob:nodedata:...` URL string returned by a prior call to
`URL.createObjectURL()`.

Expand Down
Loading
Loading