Skip to content

Commit 2f7f7ba

Browse files
jasnelljasnell
committed
fixup! doc: mark multiple fs APIs as stable
1 parent 785d37e commit 2f7f7ba

8 files changed

Lines changed: 57 additions & 83 deletions

File tree

‎doc/api/buffer.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5283,7 +5283,7 @@ An alias for [`buffer.constants.MAX_STRING_LENGTH`][].
52835283
added: v16.7.0
52845284
changes:
52855285
- version: REPLACEME
5286-
pr-url: https://github.com/nodejs/node/pull/00000
5286+
pr-url: https://github.com/nodejs/node/pull/57513
52875287
description: Marking the API stable.
52885288
-->
52895289

‎doc/api/fs.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -482,7 +482,7 @@ number of bytes read is zero.
482482
added: v17.0.0
483483
changes:
484484
- version: REPLACEME
485-
pr-url: https://github.com/nodejs/node/pull/00000
485+
pr-url: https://github.com/nodejs/node/pull/57513
486486
description: Marking the API stable.
487487
- version: v23.8.0
488488
pr-url: https://github.com/nodejs/node/pull/55461
@@ -1076,7 +1076,7 @@ behavior is similar to `cp dir1/ dir2/`.
10761076
added: v22.0.0
10771077
changes:
10781078
- version: REPLACEME
1079-
pr-url: https://github.com/nodejs/node/pull/00000
1079+
pr-url: https://github.com/nodejs/node/pull/57513
10801080
description: Marking the API stable.
10811081
- version:
10821082
- v23.7.0
@@ -3135,7 +3135,7 @@ descriptor. See [`fs.utimes()`][].
31353135
added: v22.0.0
31363136
changes:
31373137
- version: REPLACEME
3138-
pr-url: https://github.com/nodejs/node/pull/00000
3138+
pr-url: https://github.com/nodejs/node/pull/57513
31393139
description: Marking the API stable.
31403140
- version:
31413141
- v23.7.0
@@ -3588,7 +3588,7 @@ Functions based on `fs.open()` exhibit this behavior as well:
35883588
added: v19.8.0
35893589
changes:
35903590
- version: REPLACEME
3591-
pr-url: https://github.com/nodejs/node/pull/00000
3591+
pr-url: https://github.com/nodejs/node/pull/57513
35923592
description: Marking the API stable.
35933593
-->
35943594
@@ -5688,7 +5688,7 @@ Synchronous version of [`fs.futimes()`][]. Returns `undefined`.
56885688
added: v22.0.0
56895689
changes:
56905690
- version: REPLACEME
5691-
pr-url: https://github.com/nodejs/node/pull/00000
5691+
pr-url: https://github.com/nodejs/node/pull/57513
56925692
description: Marking the API stable.
56935693
- version:
56945694
- v23.7.0
@@ -6845,7 +6845,7 @@ added:
68456845
- v18.20.0
68466846
changes:
68476847
- version: REPLACEME
6848-
pr-url: https://github.com/nodejs/node/pull/00000
6848+
pr-url: https://github.com/nodejs/node/pull/57513
68496849
description: Marking the API stable.
68506850
-->
68516851

‎doc/api/readline.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@ line prompts are included in the calculations.
502502
added: v17.0.0
503503
changes:
504504
- version: REPLACEME
505-
pr-url: https://github.com/nodejs/node/pull/00000
505+
pr-url: https://github.com/nodejs/node/pull/57513
506506
description: Marking the API stable.
507507
-->
508508

‎doc/api/stream.md‎

Lines changed: 36 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -879,7 +879,7 @@ added:
879879
- v16.17.0
880880
changes:
881881
- version: REPLACEME
882-
pr-url: https://github.com/nodejs/node/pull/00000
882+
pr-url: https://github.com/nodejs/node/pull/57513
883883
description: Marking the API stable.
884884
-->
885885

@@ -1645,7 +1645,7 @@ the stream has not been destroyed or emitted `'error'` or `'end'`.
16451645
added: v16.8.0
16461646
changes:
16471647
- version: REPLACEME
1648-
pr-url: https://github.com/nodejs/node/pull/00000
1648+
pr-url: https://github.com/nodejs/node/pull/57513
16491649
description: Marking the API stable.
16501650
-->
16511651

@@ -1661,7 +1661,7 @@ added:
16611661
- v14.18.0
16621662
changes:
16631663
- version: REPLACEME
1664-
pr-url: https://github.com/nodejs/node/pull/00000
1664+
pr-url: https://github.com/nodejs/node/pull/57513
16651665
description: Marking the API stable.
16661666
-->
16671667

@@ -2011,7 +2011,7 @@ added:
20112011
- v18.13.0
20122012
changes:
20132013
- version: REPLACEME
2014-
pr-url: https://github.com/nodejs/node/pull/00000
2014+
pr-url: https://github.com/nodejs/node/pull/57513
20152015
description: Marking the API stable.
20162016
-->
20172017

@@ -2048,7 +2048,7 @@ See [`stream.compose`][] for more information.
20482048
added: v16.3.0
20492049
changes:
20502050
- version: REPLACEME
2051-
pr-url: https://github.com/nodejs/node/pull/00000
2051+
pr-url: https://github.com/nodejs/node/pull/57513
20522052
description: Marking the API stable.
20532053
-->
20542054

@@ -2105,16 +2105,15 @@ added:
21052105
- v17.4.0
21062106
- v16.14.0
21072107
changes:
2108-
- version: REPLACEME
2109-
pr-url: https://github.com/nodejs/node/pull/00000
2110-
description: Marking the API stable.
21112108
- version:
21122109
- v20.7.0
21132110
- v18.19.0
21142111
pr-url: https://github.com/nodejs/node/pull/49249
21152112
description: added `highWaterMark` in options.
21162113
-->
21172114

2115+
> Stability: 1 - Experimental
2116+
21182117
* `fn` {Function|AsyncFunction} a function to map over every chunk in the
21192118
stream.
21202119
* `data` {any} a chunk of data from the stream.
@@ -2161,16 +2160,15 @@ added:
21612160
- v17.4.0
21622161
- v16.14.0
21632162
changes:
2164-
- version: REPLACEME
2165-
pr-url: https://github.com/nodejs/node/pull/00000
2166-
description: Marking the API stable.
21672163
- version:
21682164
- v20.7.0
21692165
- v18.19.0
21702166
pr-url: https://github.com/nodejs/node/pull/49249
21712167
description: added `highWaterMark` in options.
21722168
-->
21732169

2170+
> Stability: 1 - Experimental
2171+
21742172
* `fn` {Function|AsyncFunction} a function to filter chunks from the stream.
21752173
* `data` {any} a chunk of data from the stream.
21762174
* `options` {Object}
@@ -2220,12 +2218,10 @@ for await (const result of dnsResults) {
22202218
added:
22212219
- v17.5.0
22222220
- v16.15.0
2223-
changes:
2224-
- version: REPLACEME
2225-
pr-url: https://github.com/nodejs/node/pull/00000
2226-
description: Marking the API stable.
22272221
-->
22282222

2223+
> Stability: 1 - Experimental
2224+
22292225
* `fn` {Function|AsyncFunction} a function to call on each chunk of the stream.
22302226
* `data` {any} a chunk of data from the stream.
22312227
* `options` {Object}
@@ -2283,12 +2279,10 @@ console.log('done'); // Stream has finished
22832279
added:
22842280
- v17.5.0
22852281
- v16.15.0
2286-
changes:
2287-
- version: REPLACEME
2288-
pr-url: https://github.com/nodejs/node/pull/00000
2289-
description: Marking the API stable.
22902282
-->
22912283

2284+
> Stability: 1 - Experimental
2285+
22922286
* `options` {Object}
22932287
* `signal` {AbortSignal} allows cancelling the toArray operation if the
22942288
signal is aborted.
@@ -2325,12 +2319,10 @@ const dnsResults = await Readable.from([
23252319
added:
23262320
- v17.5.0
23272321
- v16.15.0
2328-
changes:
2329-
- version: REPLACEME
2330-
pr-url: https://github.com/nodejs/node/pull/00000
2331-
description: Marking the API stable.
23322322
-->
23332323

2324+
> Stability: 1 - Experimental
2325+
23342326
* `fn` {Function|AsyncFunction} a function to call on each chunk of the stream.
23352327
* `data` {any} a chunk of data from the stream.
23362328
* `options` {Object}
@@ -2379,11 +2371,10 @@ added:
23792371
- v17.5.0
23802372
- v16.17.0
23812373
changes:
2382-
- version: REPLACEME
2383-
pr-url: https://github.com/nodejs/node/pull/00000
2384-
description: Marking the API stable.
23852374
-->
23862375

2376+
> Stability: 1 - Experimental
2377+
23872378
* `fn` {Function|AsyncFunction} a function to call on each chunk of the stream.
23882379
* `data` {any} a chunk of data from the stream.
23892380
* `options` {Object}
@@ -2432,12 +2423,10 @@ console.log('done'); // Stream has finished
24322423
added:
24332424
- v17.5.0
24342425
- v16.15.0
2435-
changes:
2436-
- version: REPLACEME
2437-
pr-url: https://github.com/nodejs/node/pull/00000
2438-
description: Marking the API stable.
24392426
-->
24402427

2428+
> Stability: 1 - Experimental
2429+
24412430
* `fn` {Function|AsyncFunction} a function to call on each chunk of the stream.
24422431
* `data` {any} a chunk of data from the stream.
24432432
* `options` {Object}
@@ -2485,12 +2474,10 @@ console.log('done'); // Stream has finished
24852474
added:
24862475
- v17.5.0
24872476
- v16.15.0
2488-
changes:
2489-
- version: REPLACEME
2490-
pr-url: https://github.com/nodejs/node/pull/00000
2491-
description: Marking the API stable.
24922477
-->
24932478

2479+
> Stability: 1 - Experimental
2480+
24942481
* `fn` {Function|AsyncGeneratorFunction|AsyncFunction} a function to map over
24952482
every chunk in the stream.
24962483
* `data` {any} a chunk of data from the stream.
@@ -2538,12 +2525,10 @@ for await (const result of concatResult) {
25382525
added:
25392526
- v17.5.0
25402527
- v16.15.0
2541-
changes:
2542-
- version: REPLACEME
2543-
pr-url: https://github.com/nodejs/node/pull/00000
2544-
description: Marking the API stable.
25452528
-->
25462529

2530+
> Stability: 1 - Experimental
2531+
25472532
* `limit` {number} the number of chunks to drop from the readable.
25482533
* `options` {Object}
25492534
* `signal` {AbortSignal} allows destroying the stream if the signal is
@@ -2565,11 +2550,10 @@ added:
25652550
- v17.5.0
25662551
- v16.15.0
25672552
changes:
2568-
- version: REPLACEME
2569-
pr-url: https://github.com/nodejs/node/pull/00000
2570-
description: Marking the API stable.
25712553
-->
25722554

2555+
> Stability: 1 - Experimental
2556+
25732557
* `limit` {number} the number of chunks to take from the readable.
25742558
* `options` {Object}
25752559
* `signal` {AbortSignal} allows destroying the stream if the signal is
@@ -2590,12 +2574,10 @@ await Readable.from([1, 2, 3, 4]).take(2).toArray(); // [1, 2]
25902574
added:
25912575
- v17.5.0
25922576
- v16.15.0
2593-
changes:
2594-
- version: REPLACEME
2595-
pr-url: https://github.com/nodejs/node/pull/00000
2596-
description: Marking the API stable.
25972577
-->
25982578

2579+
> Stability: 1 - Experimental
2580+
25992581
* `fn` {Function|AsyncFunction} a reducer function to call over every chunk
26002582
in the stream.
26012583
* `previous` {any} the value obtained from the last call to `fn` or the
@@ -3111,7 +3093,7 @@ Readable.from([
31113093
added: v17.0.0
31123094
changes:
31133095
- version: REPLACEME
3114-
pr-url: https://github.com/nodejs/node/pull/00000
3096+
pr-url: https://github.com/nodejs/node/pull/57513
31153097
description: Marking the API stable.
31163098
-->
31173099

@@ -3129,7 +3111,7 @@ changes:
31293111
added: v16.8.0
31303112
changes:
31313113
- version: REPLACEME
3132-
pr-url: https://github.com/nodejs/node/pull/00000
3114+
pr-url: https://github.com/nodejs/node/pull/57513
31333115
description: Marking the API stable.
31343116
-->
31353117

@@ -3146,7 +3128,7 @@ added:
31463128
- v16.14.0
31473129
changes:
31483130
- version: REPLACEME
3149-
pr-url: https://github.com/nodejs/node/pull/00000
3131+
pr-url: https://github.com/nodejs/node/pull/57513
31503132
description: Marking the API stable.
31513133
-->
31523134

@@ -3163,7 +3145,7 @@ added:
31633145
- v16.14.0
31643146
changes:
31653147
- version: REPLACEME
3166-
pr-url: https://github.com/nodejs/node/pull/00000
3148+
pr-url: https://github.com/nodejs/node/pull/57513
31673149
description: Marking the API stable.
31683150
-->
31693151

@@ -3178,7 +3160,7 @@ Returns whether the stream is readable.
31783160
added: v17.0.0
31793161
changes:
31803162
- version: REPLACEME
3181-
pr-url: https://github.com/nodejs/node/pull/00000
3163+
pr-url: https://github.com/nodejs/node/pull/57513
31823164
description: Marking the API stable.
31833165
- version:
31843166
- v18.7.0
@@ -3205,7 +3187,7 @@ changes:
32053187
added: v17.0.0
32063188
changes:
32073189
- version: REPLACEME
3208-
pr-url: https://github.com/nodejs/node/pull/00000
3190+
pr-url: https://github.com/nodejs/node/pull/57513
32093191
description: Marking the API stable.
32103192
-->
32113193

@@ -3223,7 +3205,7 @@ changes:
32233205
added: v17.0.0
32243206
changes:
32253207
- version: REPLACEME
3226-
pr-url: https://github.com/nodejs/node/pull/00000
3208+
pr-url: https://github.com/nodejs/node/pull/57513
32273209
description: Marking the API stable.
32283210
-->
32293211

@@ -3287,7 +3269,7 @@ Duplex.from([
32873269
added: v17.0.0
32883270
changes:
32893271
- version: REPLACEME
3290-
pr-url: https://github.com/nodejs/node/pull/00000
3272+
pr-url: https://github.com/nodejs/node/pull/57513
32913273
description: Marking the API stable.
32923274
-->
32933275

@@ -3370,7 +3352,7 @@ duplex.once('readable', () => console.log('readable', duplex.read()));
33703352
added: v17.0.0
33713353
changes:
33723354
- version: REPLACEME
3373-
pr-url: https://github.com/nodejs/node/pull/00000
3355+
pr-url: https://github.com/nodejs/node/pull/57513
33743356
description: Marking the API stable.
33753357
-->
33763358

‎doc/api/url.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -630,7 +630,7 @@ console.log(JSON.stringify(myURLs));
630630
added: v16.7.0
631631
changes:
632632
- version: REPLACEME
633-
pr-url: https://github.com/nodejs/node/pull/00000
633+
pr-url: https://github.com/nodejs/node/pull/57513
634634
description: Marking the API stable.
635635
-->
636636

@@ -668,7 +668,7 @@ to other workers or the main thread.
668668
added: v16.7.0
669669
changes:
670670
- version: REPLACEME
671-
pr-url: https://github.com/nodejs/node/pull/00000
671+
pr-url: https://github.com/nodejs/node/pull/57513
672672
description: Marking the API stable.
673673
-->
674674

0 commit comments

Comments
 (0)