Skip to content

Commit a71b9fc

Browse files
jasnelladuh95
jasnell
authored and
aduh95
committed
doc: mark multiple 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 <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>
1 parent 51fec8e commit a71b9fc

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
@@ -5277,10 +5277,12 @@ An alias for [`buffer.constants.MAX_STRING_LENGTH`][].
52775277

52785278
<!-- YAML
52795279
added: v16.7.0
5280+
changes:
5281+
- version: REPLACEME
5282+
pr-url: https://github.com/nodejs/node/pull/57513
5283+
description: Marking the API stable.
52805284
-->
52815285

5282-
> Stability: 1 - Experimental
5283-
52845286
* `id` {string} A `'blob:nodedata:...` URL string returned by a prior call to
52855287
`URL.createObjectURL()`.
52865288
* 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: v22.15.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: v22.14.0
10781082
pr-url: https://github.com/nodejs/node/pull/56489
10791083
description: Add support for `exclude` option to accept glob patterns.
@@ -1082,8 +1086,6 @@ changes:
10821086
description: Add support for `withFileTypes` as an option.
10831087
-->
10841088
1085-
> Stability: 1 - Experimental
1086-
10871089
* `pattern` {string|string\[]}
10881090
* `options` {Object}
10891091
* `cwd` {string} current working directory. **Default:** `process.cwd()`
@@ -3126,6 +3128,9 @@ descriptor. See [`fs.utimes()`][].
31263128
<!-- YAML
31273129
added: v22.0.0
31283130
changes:
3131+
- version: REPLACEME
3132+
pr-url: https://github.com/nodejs/node/pull/57513
3133+
description: Marking the API stable.
31293134
- version: v22.14.0
31303135
pr-url: https://github.com/nodejs/node/pull/56489
31313136
description: Add support for `exclude` option to accept glob patterns.
@@ -3134,8 +3139,6 @@ changes:
31343139
description: Add support for `withFileTypes` as an option.
31353140
-->
31363141
3137-
> Stability: 1 - Experimental
3138-
31393142
* `pattern` {string|string\[]}
31403143
31413144
* `options` {Object}
@@ -3575,10 +3578,12 @@ Functions based on `fs.open()` exhibit this behavior as well:
35753578
35763579
<!-- YAML
35773580
added: v19.8.0
3581+
changes:
3582+
- version: REPLACEME
3583+
pr-url: https://github.com/nodejs/node/pull/57513
3584+
description: Marking the API stable.
35783585
-->
35793586
3580-
> Stability: 1 - Experimental
3581-
35823587
* `path` {string|Buffer|URL}
35833588
* `options` {Object}
35843589
* `type` {string} An optional mime type for the blob.
@@ -5674,6 +5679,9 @@ Synchronous version of [`fs.futimes()`][]. Returns `undefined`.
56745679
<!-- YAML
56755680
added: v22.0.0
56765681
changes:
5682+
- version: REPLACEME
5683+
pr-url: https://github.com/nodejs/node/pull/57513
5684+
description: Marking the API stable.
56775685
- version: v22.14.0
56785686
pr-url: https://github.com/nodejs/node/pull/56489
56795687
description: Add support for `exclude` option to accept glob patterns.
@@ -5682,8 +5690,6 @@ changes:
56825690
description: Add support for `withFileTypes` as an option.
56835691
-->
56845692
5685-
> Stability: 1 - Experimental
5686-
56875693
* `pattern` {string|string\[]}
56885694
* `options` {Object}
56895695
* `cwd` {string} current working directory. **Default:** `process.cwd()`
@@ -6827,10 +6833,12 @@ added:
68276833
- v21.4.0
68286834
- v20.12.0
68296835
- v18.20.0
6836+
changes:
6837+
- version: REPLACEME
6838+
pr-url: https://github.com/nodejs/node/pull/57513
6839+
description: Marking the API stable.
68306840
-->
68316841
6832-
> Stability: 1 - Experimental
6833-
68346842
* {string}
68356843
68366844
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
@@ -875,10 +875,12 @@ the stream has not been destroyed, errored, or ended.
875875
added:
876876
- v18.0.0
877877
- v16.17.0
878+
changes:
879+
- version: REPLACEME
880+
pr-url: https://github.com/nodejs/node/pull/57513
881+
description: Marking the API stable.
878882
-->
879883

880-
> Stability: 1 - Experimental
881-
882884
* {boolean}
883885

884886
Returns whether the stream was destroyed or errored before emitting `'finish'`.
@@ -1635,10 +1637,12 @@ the stream has not been destroyed or emitted `'error'` or `'end'`.
16351637

16361638
<!-- YAML
16371639
added: v16.8.0
1640+
changes:
1641+
- version: REPLACEME
1642+
pr-url: https://github.com/nodejs/node/pull/57513
1643+
description: Marking the API stable.
16381644
-->
16391645

1640-
> Stability: 1 - Experimental
1641-
16421646
* {boolean}
16431647

16441648
Returns whether the stream was destroyed or errored before emitting `'end'`.
@@ -1649,10 +1653,12 @@ Returns whether the stream was destroyed or errored before emitting `'end'`.
16491653
added:
16501654
- v16.7.0
16511655
- v14.18.0
1656+
changes:
1657+
- version: REPLACEME
1658+
pr-url: https://github.com/nodejs/node/pull/57513
1659+
description: Marking the API stable.
16521660
-->
16531661

1654-
> Stability: 1 - Experimental
1655-
16561662
* {boolean}
16571663

16581664
Returns whether `'data'` has been emitted.
@@ -1995,10 +2001,12 @@ a promise that fulfills when the stream is finished.
19952001
added:
19962002
- v19.1.0
19972003
- v18.13.0
2004+
changes:
2005+
- version: REPLACEME
2006+
pr-url: https://github.com/nodejs/node/pull/57513
2007+
description: Marking the API stable.
19982008
-->
19992009

2000-
> Stability: 1 - Experimental
2001-
20022010
* `stream` {Stream|Iterable|AsyncIterable|Function}
20032011
* `options` {Object}
20042012
* `signal` {AbortSignal} allows destroying the stream if the signal is
@@ -2030,10 +2038,12 @@ See [`stream.compose`][] for more information.
20302038

20312039
<!-- YAML
20322040
added: v16.3.0
2041+
changes:
2042+
- version: REPLACEME
2043+
pr-url: https://github.com/nodejs/node/pull/57513
2044+
description: Marking the API stable.
20332045
-->
20342046

2035-
> Stability: 1 - Experimental
2036-
20372047
* `options` {Object}
20382048
* `destroyOnReturn` {boolean} When set to `false`, calling `return` on the
20392049
async iterator, or exiting a `for await...of` iteration using a `break`,
@@ -3069,10 +3079,12 @@ Readable.from([
30693079

30703080
<!-- YAML
30713081
added: v17.0.0
3082+
changes:
3083+
- version: REPLACEME
3084+
pr-url: https://github.com/nodejs/node/pull/57513
3085+
description: Marking the API stable.
30723086
-->
30733087

3074-
> Stability: 1 - Experimental
3075-
30763088
* `readableStream` {ReadableStream}
30773089
* `options` {Object}
30783090
* `encoding` {string}
@@ -3085,10 +3097,12 @@ added: v17.0.0
30853097

30863098
<!-- YAML
30873099
added: v16.8.0
3100+
changes:
3101+
- version: REPLACEME
3102+
pr-url: https://github.com/nodejs/node/pull/57513
3103+
description: Marking the API stable.
30883104
-->
30893105

3090-
> Stability: 1 - Experimental
3091-
30923106
* `stream` {stream.Readable|ReadableStream}
30933107
* Returns: `boolean`
30943108

@@ -3100,10 +3114,12 @@ Returns whether the stream has been read from or cancelled.
31003114
added:
31013115
- v17.3.0
31023116
- v16.14.0
3117+
changes:
3118+
- version: REPLACEME
3119+
pr-url: https://github.com/nodejs/node/pull/57513
3120+
description: Marking the API stable.
31033121
-->
31043122

3105-
> Stability: 1 - Experimental
3106-
31073123
* `stream` {Readable|Writable|Duplex|WritableStream|ReadableStream}
31083124
* Returns: {boolean}
31093125

@@ -3115,10 +3131,12 @@ Returns whether the stream has encountered an error.
31153131
added:
31163132
- v17.4.0
31173133
- v16.14.0
3134+
changes:
3135+
- version: REPLACEME
3136+
pr-url: https://github.com/nodejs/node/pull/57513
3137+
description: Marking the API stable.
31183138
-->
31193139

3120-
> Stability: 1 - Experimental
3121-
31223140
* `stream` {Readable|Duplex|ReadableStream}
31233141
* Returns: {boolean}
31243142

@@ -3129,14 +3147,15 @@ Returns whether the stream is readable.
31293147
<!-- YAML
31303148
added: v17.0.0
31313149
changes:
3150+
- version: REPLACEME
3151+
pr-url: https://github.com/nodejs/node/pull/57513
3152+
description: Marking the API stable.
31323153
- version:
31333154
- v18.7.0
31343155
pr-url: https://github.com/nodejs/node/pull/43515
31353156
description: include strategy options on Readable.
31363157
-->
31373158

3138-
> Stability: 1 - Experimental
3139-
31403159
* `streamReadable` {stream.Readable}
31413160
* `options` {Object}
31423161
* `strategy` {Object}
@@ -3154,10 +3173,12 @@ changes:
31543173

31553174
<!-- YAML
31563175
added: v17.0.0
3176+
changes:
3177+
- version: REPLACEME
3178+
pr-url: https://github.com/nodejs/node/pull/57513
3179+
description: Marking the API stable.
31573180
-->
31583181

3159-
> Stability: 1 - Experimental
3160-
31613182
* `writableStream` {WritableStream}
31623183
* `options` {Object}
31633184
* `decodeStrings` {boolean}
@@ -3170,10 +3191,12 @@ added: v17.0.0
31703191

31713192
<!-- YAML
31723193
added: v17.0.0
3194+
changes:
3195+
- version: REPLACEME
3196+
pr-url: https://github.com/nodejs/node/pull/57513
3197+
description: Marking the API stable.
31733198
-->
31743199

3175-
> Stability: 1 - Experimental
3176-
31773200
* `streamWritable` {stream.Writable}
31783201
* Returns: {WritableStream}
31793202

@@ -3232,10 +3255,12 @@ Duplex.from([
32323255

32333256
<!-- YAML
32343257
added: v17.0.0
3258+
changes:
3259+
- version: REPLACEME
3260+
pr-url: https://github.com/nodejs/node/pull/57513
3261+
description: Marking the API stable.
32353262
-->
32363263

3237-
> Stability: 1 - Experimental
3238-
32393264
* `pair` {Object}
32403265
* `readable` {ReadableStream}
32413266
* `writable` {WritableStream}
@@ -3313,10 +3338,12 @@ duplex.once('readable', () => console.log('readable', duplex.read()));
33133338

33143339
<!-- YAML
33153340
added: v17.0.0
3341+
changes:
3342+
- version: REPLACEME
3343+
pr-url: https://github.com/nodejs/node/pull/57513
3344+
description: Marking the API stable.
33163345
-->
33173346

3318-
> Stability: 1 - Experimental
3319-
33203347
* `streamDuplex` {stream.Duplex}
33213348
* Returns: {Object}
33223349
* `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)