Skip to content

Commit e720be4

Browse files
jasnellRafaelGSS
jasnell
authored and
RafaelGSS
committed
doc: mark multiple experimental APIS as stable
* AsyncLocalStorage snapshot and bind APIs * multiple web streams apis * MIMEType API * Transferable AbortSignal/Controller PR-URL: #57510 Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>
1 parent ff18435 commit e720be4

File tree

3 files changed

+88
-44
lines changed

3 files changed

+88
-44
lines changed

‎doc/api/async_context.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -144,10 +144,12 @@ Creates a new instance of `AsyncLocalStorage`. Store is only provided within a
144144
added:
145145
- v19.8.0
146146
- v18.16.0
147+
changes:
148+
- version: REPLACEME
149+
pr-url: https://github.com/nodejs/node/pull/57510
150+
description: Marking the API stable.
147151
-->
148152

149-
> Stability: 1 - Experimental
150-
151153
* `fn` {Function} The function to bind to the current execution context.
152154
* Returns: {Function} A new function that calls `fn` within the captured
153155
execution context.
@@ -160,10 +162,12 @@ Binds the given function to the current execution context.
160162
added:
161163
- v19.8.0
162164
- v18.16.0
165+
changes:
166+
- version: REPLACEME
167+
pr-url: https://github.com/nodejs/node/pull/57510
168+
description: Marking the API stable.
163169
-->
164170

165-
> Stability: 1 - Experimental
166-
167171
* Returns: {Function} A new function with the signature
168172
`(fn: (...args) : R, ...args) : R`.
169173

‎doc/api/globals.md

Lines changed: 68 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -250,10 +250,12 @@ Used to handle binary data. See the [buffer section][].
250250

251251
<!-- YAML
252252
added: v18.0.0
253+
changes:
254+
- version: REPLACEME
255+
pr-url: https://github.com/nodejs/node/pull/57510
256+
description: Marking the API stable.
253257
-->
254258

255-
> Stability: 1 - Experimental.
256-
257259
A browser-compatible implementation of [`ByteLengthQueuingStrategy`][].
258260

259261
## `__dirname`
@@ -339,10 +341,12 @@ with the [`--no-experimental-websocket`][] CLI flag.
339341

340342
<!-- YAML
341343
added: v18.0.0
344+
changes:
345+
- version: REPLACEME
346+
pr-url: https://github.com/nodejs/node/pull/57510
347+
description: Marking the API stable.
342348
-->
343349

344-
> Stability: 1 - Experimental.
345-
346350
A browser-compatible implementation of [`CompressionStream`][].
347351

348352
## `console`
@@ -361,10 +365,12 @@ Used to print to stdout and stderr. See the [`console`][] section.
361365

362366
<!-- YAML
363367
added: v18.0.0
368+
changes:
369+
- version: REPLACEME
370+
pr-url: https://github.com/nodejs/node/pull/57510
371+
description: Marking the API stable.
364372
-->
365373

366-
> Stability: 1 - Experimental.
367-
368374
A browser-compatible implementation of [`CountQueuingStrategy`][].
369375

370376
## `Crypto`
@@ -458,10 +464,12 @@ A browser-compatible implementation of the [`CustomEvent` Web API][].
458464

459465
<!-- YAML
460466
added: v18.0.0
467+
changes:
468+
- version: REPLACEME
469+
pr-url: https://github.com/nodejs/node/pull/57510
470+
description: Marking the API stable.
461471
-->
462472

463-
> Stability: 1 - Experimental.
464-
465473
A browser-compatible implementation of [`DecompressionStream`][].
466474

467475
## `Event`
@@ -884,60 +892,72 @@ DataHandler.prototype.load = async function load(key) {
884892

885893
<!-- YAML
886894
added: v18.0.0
895+
changes:
896+
- version: REPLACEME
897+
pr-url: https://github.com/nodejs/node/pull/57510
898+
description: Marking the API stable.
887899
-->
888900

889-
> Stability: 1 - Experimental.
890-
891901
A browser-compatible implementation of [`ReadableByteStreamController`][].
892902

893903
## Class: `ReadableStream`
894904

895905
<!-- YAML
896906
added: v18.0.0
907+
changes:
908+
- version: REPLACEME
909+
pr-url: https://github.com/nodejs/node/pull/57510
910+
description: Marking the API stable.
897911
-->
898912

899-
> Stability: 1 - Experimental.
900-
901913
A browser-compatible implementation of [`ReadableStream`][].
902914

903915
## Class: `ReadableStreamBYOBReader`
904916

905917
<!-- YAML
906918
added: v18.0.0
919+
changes:
920+
- version: REPLACEME
921+
pr-url: https://github.com/nodejs/node/pull/57510
922+
description: Marking the API stable.
907923
-->
908924

909-
> Stability: 1 - Experimental.
910-
911925
A browser-compatible implementation of [`ReadableStreamBYOBReader`][].
912926

913927
## Class: `ReadableStreamBYOBRequest`
914928

915929
<!-- YAML
916930
added: v18.0.0
931+
changes:
932+
- version: REPLACEME
933+
pr-url: https://github.com/nodejs/node/pull/57510
934+
description: Marking the API stable.
917935
-->
918936

919-
> Stability: 1 - Experimental.
920-
921937
A browser-compatible implementation of [`ReadableStreamBYOBRequest`][].
922938

923939
## Class: `ReadableStreamDefaultController`
924940

925941
<!-- YAML
926942
added: v18.0.0
943+
changes:
944+
- version: REPLACEME
945+
pr-url: https://github.com/nodejs/node/pull/57510
946+
description: Marking the API stable.
927947
-->
928948

929-
> Stability: 1 - Experimental.
930-
931949
A browser-compatible implementation of [`ReadableStreamDefaultController`][].
932950

933951
## Class: `ReadableStreamDefaultReader`
934952

935953
<!-- YAML
936954
added: v18.0.0
955+
changes:
956+
- version: REPLACEME
957+
pr-url: https://github.com/nodejs/node/pull/57510
958+
description: Marking the API stable.
937959
-->
938960

939-
> Stability: 1 - Experimental.
940-
941961
A browser-compatible implementation of [`ReadableStreamDefaultReader`][].
942962

943963
## `require()`
@@ -1089,10 +1109,12 @@ The WHATWG `TextDecoder` class. See the [`TextDecoder`][] section.
10891109

10901110
<!-- YAML
10911111
added: v18.0.0
1112+
changes:
1113+
- version: REPLACEME
1114+
pr-url: https://github.com/nodejs/node/pull/57510
1115+
description: Marking the API stable.
10921116
-->
10931117

1094-
> Stability: 1 - Experimental.
1095-
10961118
A browser-compatible implementation of [`TextDecoderStream`][].
10971119

10981120
## `TextEncoder`
@@ -1109,30 +1131,36 @@ The WHATWG `TextEncoder` class. See the [`TextEncoder`][] section.
11091131

11101132
<!-- YAML
11111133
added: v18.0.0
1134+
changes:
1135+
- version: REPLACEME
1136+
pr-url: https://github.com/nodejs/node/pull/57510
1137+
description: Marking the API stable.
11121138
-->
11131139

1114-
> Stability: 1 - Experimental.
1115-
11161140
A browser-compatible implementation of [`TextEncoderStream`][].
11171141

11181142
## Class: `TransformStream`
11191143

11201144
<!-- YAML
11211145
added: v18.0.0
1146+
changes:
1147+
- version: REPLACEME
1148+
pr-url: https://github.com/nodejs/node/pull/57510
1149+
description: Marking the API stable.
11221150
-->
11231151

1124-
> Stability: 1 - Experimental.
1125-
11261152
A browser-compatible implementation of [`TransformStream`][].
11271153

11281154
## Class: `TransformStreamDefaultController`
11291155

11301156
<!-- YAML
11311157
added: v18.0.0
1158+
changes:
1159+
- version: REPLACEME
1160+
pr-url: https://github.com/nodejs/node/pull/57510
1161+
description: Marking the API stable.
11321162
-->
11331163

1134-
> Stability: 1 - Experimental.
1135-
11361164
A browser-compatible implementation of [`TransformStreamDefaultController`][].
11371165

11381166
## `URL`
@@ -1203,30 +1231,36 @@ with the [`--no-experimental-websocket`][] CLI flag.
12031231

12041232
<!-- YAML
12051233
added: v18.0.0
1234+
changes:
1235+
- version: REPLACEME
1236+
pr-url: https://github.com/nodejs/node/pull/57510
1237+
description: Marking the API stable.
12061238
-->
12071239

1208-
> Stability: 1 - Experimental.
1209-
12101240
A browser-compatible implementation of [`WritableStream`][].
12111241

12121242
## Class: `WritableStreamDefaultController`
12131243

12141244
<!-- YAML
12151245
added: v18.0.0
1246+
changes:
1247+
- version: REPLACEME
1248+
pr-url: https://github.com/nodejs/node/pull/57510
1249+
description: Marking the API stable.
12161250
-->
12171251

1218-
> Stability: 1 - Experimental.
1219-
12201252
A browser-compatible implementation of [`WritableStreamDefaultController`][].
12211253

12221254
## Class: `WritableStreamDefaultWriter`
12231255

12241256
<!-- YAML
12251257
added: v18.0.0
1258+
changes:
1259+
- version: REPLACEME
1260+
pr-url: https://github.com/nodejs/node/pull/57510
1261+
description: Marking the API stable.
12261262
-->
12271263

1228-
> Stability: 1 - Experimental.
1229-
12301264
A browser-compatible implementation of [`WritableStreamDefaultWriter`][].
12311265

12321266
[CommonJS module]: modules.md

‎doc/api/util.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1561,10 +1561,12 @@ equality.
15611561
added:
15621562
- v19.1.0
15631563
- v18.13.0
1564+
changes:
1565+
- version: REPLACEME
1566+
pr-url: https://github.com/nodejs/node/pull/57510
1567+
description: Marking the API stable.
15641568
-->
15651569

1566-
> Stability: 1 - Experimental
1567-
15681570
An implementation of [the MIMEType class](https://bmeck.github.io/node-proposal-mime-api/).
15691571

15701572
In accordance with browser conventions, all properties of `MIMEType` objects
@@ -2691,21 +2693,25 @@ Unicode "replacement character" U+FFFD.
26912693
26922694
<!-- YAML
26932695
added: v18.11.0
2696+
changes:
2697+
- version: REPLACEME
2698+
pr-url: https://github.com/nodejs/node/pull/57510
2699+
description: Marking the API stable.
26942700
-->
26952701
2696-
> Stability: 1 - Experimental
2697-
26982702
Creates and returns an {AbortController} instance whose {AbortSignal} is marked
26992703
as transferable and can be used with `structuredClone()` or `postMessage()`.
27002704
27012705
## `util.transferableAbortSignal(signal)`
27022706
27032707
<!-- YAML
27042708
added: v18.11.0
2709+
changes:
2710+
- version: REPLACEME
2711+
pr-url: https://github.com/nodejs/node/pull/57510
2712+
description: Marking the API stable.
27052713
-->
27062714
2707-
> Stability: 1 - Experimental
2708-
27092715
* `signal` {AbortSignal}
27102716
* Returns: {AbortSignal}
27112717

0 commit comments

Comments
 (0)