Skip to content

Commit 1e920a0

Browse files
jasnellRafaelGSS
jasnell
authored and
RafaelGSS
committed
doc: mark multiple vm module APIS stable
I'm guessing 5-7 years is long enough to be experimental * mark worker_threads API stable * mark multiple v8 module APIs stable * mark object url APIs stable * mark more streams apis stable * mark readline promises api stable * mark multiple fs APIs as stable PR-URL: #57513 Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
1 parent 489ddf2 commit 1e920a0

File tree

7 files changed

+103
-54
lines changed

7 files changed

+103
-54
lines changed

‎doc/api/buffer.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5281,10 +5281,12 @@ An alias for [`buffer.constants.MAX_STRING_LENGTH`][].
52815281

52825282
<!-- YAML
52835283
added: v16.7.0
5284+
changes:
5285+
- version: REPLACEME
5286+
pr-url: https://github.com/nodejs/node/pull/57513
5287+
description: Marking the API stable.
52845288
-->
52855289

5286-
> Stability: 1 - Experimental
5287-
52885290
* `id` {string} A `'blob:nodedata:...` URL string returned by a prior call to
52895291
`URL.createObjectURL()`.
52905292
* Returns: {Blob}

‎doc/api/fs.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -481,6 +481,9 @@ number of bytes read is zero.
481481
<!-- YAML
482482
added: v17.0.0
483483
changes:
484+
- version: REPLACEME
485+
pr-url: https://github.com/nodejs/node/pull/57513
486+
description: Marking the API stable.
484487
- version: v23.8.0
485488
pr-url: https://github.com/nodejs/node/pull/55461
486489
description: Removed option to create a 'bytes' stream. Streams are now always 'bytes' streams.
@@ -491,8 +494,6 @@ changes:
491494
description: Added option to create a 'bytes' stream.
492495
-->
493496
494-
> Stability: 1 - Experimental
495-
496497
* Returns: {ReadableStream}
497498
498499
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/`.
10741075
<!-- YAML
10751076
added: v22.0.0
10761077
changes:
1078+
- version: REPLACEME
1079+
pr-url: https://github.com/nodejs/node/pull/57513
1080+
description: Marking the API stable.
10771081
- version:
10781082
- v23.7.0
10791083
- v22.14.0
@@ -1084,8 +1088,6 @@ changes:
10841088
description: Add support for `withFileTypes` as an option.
10851089
-->
10861090
1087-
> Stability: 1 - Experimental
1088-
10891091
* `pattern` {string|string\[]}
10901092
* `options` {Object}
10911093
* `cwd` {string} current working directory. **Default:** `process.cwd()`
@@ -3128,6 +3130,9 @@ descriptor. See [`fs.utimes()`][].
31283130
<!-- YAML
31293131
added: v22.0.0
31303132
changes:
3133+
- version: REPLACEME
3134+
pr-url: https://github.com/nodejs/node/pull/57513
3135+
description: Marking the API stable.
31313136
- version:
31323137
- v23.7.0
31333138
- v22.14.0
@@ -3138,8 +3143,6 @@ changes:
31383143
description: Add support for `withFileTypes` as an option.
31393144
-->
31403145
3141-
> Stability: 1 - Experimental
3142-
31433146
* `pattern` {string|string\[]}
31443147
31453148
* `options` {Object}
@@ -3579,10 +3582,12 @@ Functions based on `fs.open()` exhibit this behavior as well:
35793582
35803583
<!-- YAML
35813584
added: v19.8.0
3585+
changes:
3586+
- version: REPLACEME
3587+
pr-url: https://github.com/nodejs/node/pull/57513
3588+
description: Marking the API stable.
35823589
-->
35833590
3584-
> Stability: 1 - Experimental
3585-
35863591
* `path` {string|Buffer|URL}
35873592
* `options` {Object}
35883593
* `type` {string} An optional mime type for the blob.
@@ -5678,6 +5683,9 @@ Synchronous version of [`fs.futimes()`][]. Returns `undefined`.
56785683
<!-- YAML
56795684
added: v22.0.0
56805685
changes:
5686+
- version: REPLACEME
5687+
pr-url: https://github.com/nodejs/node/pull/57513
5688+
description: Marking the API stable.
56815689
- version:
56825690
- v23.7.0
56835691
- v22.14.0
@@ -5688,8 +5696,6 @@ changes:
56885696
description: Add support for `withFileTypes` as an option.
56895697
-->
56905698
5691-
> Stability: 1 - Experimental
5692-
56935699
* `pattern` {string|string\[]}
56945700
* `options` {Object}
56955701
* `cwd` {string} current working directory. **Default:** `process.cwd()`
@@ -6833,10 +6839,12 @@ added:
68336839
- v21.4.0
68346840
- v20.12.0
68356841
- v18.20.0
6842+
changes:
6843+
- version: REPLACEME
6844+
pr-url: https://github.com/nodejs/node/pull/57513
6845+
description: Marking the API stable.
68366846
-->
68376847
6838-
> Stability: 1 - Experimental
6839-
68406848
* {string}
68416849
68426850
The path to the parent directory of the file this {fs.Dirent} object refers to.

‎doc/api/readline.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -500,10 +500,12 @@ line prompts are included in the calculations.
500500

501501
<!-- YAML
502502
added: v17.0.0
503+
changes:
504+
- version: REPLACEME
505+
pr-url: https://github.com/nodejs/node/pull/57513
506+
description: Marking the API stable.
503507
-->
504508

505-
> Stability: 1 - Experimental
506-
507509
### Class: `readlinePromises.Interface`
508510

509511
<!-- YAML

‎doc/api/stream.md

Lines changed: 55 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -877,10 +877,12 @@ the stream has not been destroyed, errored, or ended.
877877
added:
878878
- v18.0.0
879879
- v16.17.0
880+
changes:
881+
- version: REPLACEME
882+
pr-url: https://github.com/nodejs/node/pull/57513
883+
description: Marking the API stable.
880884
-->
881885

882-
> Stability: 1 - Experimental
883-
884886
* {boolean}
885887

886888
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'`.
16411643

16421644
<!-- YAML
16431645
added: v16.8.0
1646+
changes:
1647+
- version: REPLACEME
1648+
pr-url: https://github.com/nodejs/node/pull/57513
1649+
description: Marking the API stable.
16441650
-->
16451651

1646-
> Stability: 1 - Experimental
1647-
16481652
* {boolean}
16491653

16501654
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'`.
16551659
added:
16561660
- v16.7.0
16571661
- v14.18.0
1662+
changes:
1663+
- version: REPLACEME
1664+
pr-url: https://github.com/nodejs/node/pull/57513
1665+
description: Marking the API stable.
16581666
-->
16591667

1660-
> Stability: 1 - Experimental
1661-
16621668
* {boolean}
16631669

16641670
Returns whether `'data'` has been emitted.
@@ -2003,10 +2009,12 @@ a promise that fulfills when the stream is finished.
20032009
added:
20042010
- v19.1.0
20052011
- v18.13.0
2012+
changes:
2013+
- version: REPLACEME
2014+
pr-url: https://github.com/nodejs/node/pull/57513
2015+
description: Marking the API stable.
20062016
-->
20072017

2008-
> Stability: 1 - Experimental
2009-
20102018
* `stream` {Stream|Iterable|AsyncIterable|Function}
20112019
* `options` {Object}
20122020
* `signal` {AbortSignal} allows destroying the stream if the signal is
@@ -2038,10 +2046,12 @@ See [`stream.compose`][] for more information.
20382046

20392047
<!-- YAML
20402048
added: v16.3.0
2049+
changes:
2050+
- version: REPLACEME
2051+
pr-url: https://github.com/nodejs/node/pull/57513
2052+
description: Marking the API stable.
20412053
-->
20422054

2043-
> Stability: 1 - Experimental
2044-
20452055
* `options` {Object}
20462056
* `destroyOnReturn` {boolean} When set to `false`, calling `return` on the
20472057
async iterator, or exiting a `for await...of` iteration using a `break`,
@@ -3079,10 +3089,12 @@ Readable.from([
30793089

30803090
<!-- YAML
30813091
added: v17.0.0
3092+
changes:
3093+
- version: REPLACEME
3094+
pr-url: https://github.com/nodejs/node/pull/57513
3095+
description: Marking the API stable.
30823096
-->
30833097

3084-
> Stability: 1 - Experimental
3085-
30863098
* `readableStream` {ReadableStream}
30873099
* `options` {Object}
30883100
* `encoding` {string}
@@ -3095,10 +3107,12 @@ added: v17.0.0
30953107

30963108
<!-- YAML
30973109
added: v16.8.0
3110+
changes:
3111+
- version: REPLACEME
3112+
pr-url: https://github.com/nodejs/node/pull/57513
3113+
description: Marking the API stable.
30983114
-->
30993115

3100-
> Stability: 1 - Experimental
3101-
31023116
* `stream` {stream.Readable|ReadableStream}
31033117
* Returns: `boolean`
31043118

@@ -3110,10 +3124,12 @@ Returns whether the stream has been read from or cancelled.
31103124
added:
31113125
- v17.3.0
31123126
- v16.14.0
3127+
changes:
3128+
- version: REPLACEME
3129+
pr-url: https://github.com/nodejs/node/pull/57513
3130+
description: Marking the API stable.
31133131
-->
31143132

3115-
> Stability: 1 - Experimental
3116-
31173133
* `stream` {Readable|Writable|Duplex|WritableStream|ReadableStream}
31183134
* Returns: {boolean}
31193135

@@ -3125,10 +3141,12 @@ Returns whether the stream has encountered an error.
31253141
added:
31263142
- v17.4.0
31273143
- v16.14.0
3144+
changes:
3145+
- version: REPLACEME
3146+
pr-url: https://github.com/nodejs/node/pull/57513
3147+
description: Marking the API stable.
31283148
-->
31293149

3130-
> Stability: 1 - Experimental
3131-
31323150
* `stream` {Readable|Duplex|ReadableStream}
31333151
* Returns: {boolean}
31343152

@@ -3139,14 +3157,15 @@ Returns whether the stream is readable.
31393157
<!-- YAML
31403158
added: v17.0.0
31413159
changes:
3160+
- version: REPLACEME
3161+
pr-url: https://github.com/nodejs/node/pull/57513
3162+
description: Marking the API stable.
31423163
- version:
31433164
- v18.7.0
31443165
pr-url: https://github.com/nodejs/node/pull/43515
31453166
description: include strategy options on Readable.
31463167
-->
31473168

3148-
> Stability: 1 - Experimental
3149-
31503169
* `streamReadable` {stream.Readable}
31513170
* `options` {Object}
31523171
* `strategy` {Object}
@@ -3164,10 +3183,12 @@ changes:
31643183

31653184
<!-- YAML
31663185
added: v17.0.0
3186+
changes:
3187+
- version: REPLACEME
3188+
pr-url: https://github.com/nodejs/node/pull/57513
3189+
description: Marking the API stable.
31673190
-->
31683191

3169-
> Stability: 1 - Experimental
3170-
31713192
* `writableStream` {WritableStream}
31723193
* `options` {Object}
31733194
* `decodeStrings` {boolean}
@@ -3180,10 +3201,12 @@ added: v17.0.0
31803201

31813202
<!-- YAML
31823203
added: v17.0.0
3204+
changes:
3205+
- version: REPLACEME
3206+
pr-url: https://github.com/nodejs/node/pull/57513
3207+
description: Marking the API stable.
31833208
-->
31843209

3185-
> Stability: 1 - Experimental
3186-
31873210
* `streamWritable` {stream.Writable}
31883211
* Returns: {WritableStream}
31893212

@@ -3242,10 +3265,12 @@ Duplex.from([
32423265

32433266
<!-- YAML
32443267
added: v17.0.0
3268+
changes:
3269+
- version: REPLACEME
3270+
pr-url: https://github.com/nodejs/node/pull/57513
3271+
description: Marking the API stable.
32453272
-->
32463273

3247-
> Stability: 1 - Experimental
3248-
32493274
* `pair` {Object}
32503275
* `readable` {ReadableStream}
32513276
* `writable` {WritableStream}
@@ -3323,10 +3348,12 @@ duplex.once('readable', () => console.log('readable', duplex.read()));
33233348

33243349
<!-- YAML
33253350
added: v17.0.0
3351+
changes:
3352+
- version: REPLACEME
3353+
pr-url: https://github.com/nodejs/node/pull/57513
3354+
description: Marking the API stable.
33263355
-->
33273356

3328-
> Stability: 1 - Experimental
3329-
33303357
* `streamDuplex` {stream.Duplex}
33313358
* Returns: {Object}
33323359
* `readable` {ReadableStream}

‎doc/api/url.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -628,10 +628,12 @@ console.log(JSON.stringify(myURLs));
628628

629629
<!-- YAML
630630
added: v16.7.0
631+
changes:
632+
- version: REPLACEME
633+
pr-url: https://github.com/nodejs/node/pull/57513
634+
description: Marking the API stable.
631635
-->
632636

633-
> Stability: 1 - Experimental
634-
635637
* `blob` {Blob}
636638
* Returns: {string}
637639

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

665667
<!-- YAML
666668
added: v16.7.0
669+
changes:
670+
- version: REPLACEME
671+
pr-url: https://github.com/nodejs/node/pull/57513
672+
description: Marking the API stable.
667673
-->
668674

669-
> Stability: 1 - Experimental
670-
671675
* `id` {string} A `'blob:nodedata:...` URL string returned by a prior call to
672676
`URL.createObjectURL()`.
673677

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy