Skip to content

Commit a8d65e9

Browse files
jasnelladuh95
jasnell
authored and
aduh95
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 4186b49 commit a8d65e9

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`
@@ -326,10 +328,12 @@ added: v0.0.1
326328

327329
<!-- YAML
328330
added: v18.0.0
331+
changes:
332+
- version: REPLACEME
333+
pr-url: https://github.com/nodejs/node/pull/57510
334+
description: Marking the API stable.
329335
-->
330336

331-
> Stability: 1 - Experimental.
332-
333337
A browser-compatible implementation of [`CompressionStream`][].
334338

335339
## `console`
@@ -348,10 +352,12 @@ Used to print to stdout and stderr. See the [`console`][] section.
348352

349353
<!-- YAML
350354
added: v18.0.0
355+
changes:
356+
- version: REPLACEME
357+
pr-url: https://github.com/nodejs/node/pull/57510
358+
description: Marking the API stable.
351359
-->
352360

353-
> Stability: 1 - Experimental.
354-
355361
A browser-compatible implementation of [`CountQueuingStrategy`][].
356362

357363
## `Crypto`
@@ -437,10 +443,12 @@ A browser-compatible implementation of the [`CustomEvent` Web API][].
437443

438444
<!-- YAML
439445
added: v18.0.0
446+
changes:
447+
- version: REPLACEME
448+
pr-url: https://github.com/nodejs/node/pull/57510
449+
description: Marking the API stable.
440450
-->
441451

442-
> Stability: 1 - Experimental.
443-
444452
A browser-compatible implementation of [`DecompressionStream`][].
445453

446454
## `Event`
@@ -861,60 +869,72 @@ DataHandler.prototype.load = async function load(key) {
861869

862870
<!-- YAML
863871
added: v18.0.0
872+
changes:
873+
- version: REPLACEME
874+
pr-url: https://github.com/nodejs/node/pull/57510
875+
description: Marking the API stable.
864876
-->
865877

866-
> Stability: 1 - Experimental.
867-
868878
A browser-compatible implementation of [`ReadableByteStreamController`][].
869879

870880
## Class: `ReadableStream`
871881

872882
<!-- YAML
873883
added: v18.0.0
884+
changes:
885+
- version: REPLACEME
886+
pr-url: https://github.com/nodejs/node/pull/57510
887+
description: Marking the API stable.
874888
-->
875889

876-
> Stability: 1 - Experimental.
877-
878890
A browser-compatible implementation of [`ReadableStream`][].
879891

880892
## Class: `ReadableStreamBYOBReader`
881893

882894
<!-- YAML
883895
added: v18.0.0
896+
changes:
897+
- version: REPLACEME
898+
pr-url: https://github.com/nodejs/node/pull/57510
899+
description: Marking the API stable.
884900
-->
885901

886-
> Stability: 1 - Experimental.
887-
888902
A browser-compatible implementation of [`ReadableStreamBYOBReader`][].
889903

890904
## Class: `ReadableStreamBYOBRequest`
891905

892906
<!-- YAML
893907
added: v18.0.0
908+
changes:
909+
- version: REPLACEME
910+
pr-url: https://github.com/nodejs/node/pull/57510
911+
description: Marking the API stable.
894912
-->
895913

896-
> Stability: 1 - Experimental.
897-
898914
A browser-compatible implementation of [`ReadableStreamBYOBRequest`][].
899915

900916
## Class: `ReadableStreamDefaultController`
901917

902918
<!-- YAML
903919
added: v18.0.0
920+
changes:
921+
- version: REPLACEME
922+
pr-url: https://github.com/nodejs/node/pull/57510
923+
description: Marking the API stable.
904924
-->
905925

906-
> Stability: 1 - Experimental.
907-
908926
A browser-compatible implementation of [`ReadableStreamDefaultController`][].
909927

910928
## Class: `ReadableStreamDefaultReader`
911929

912930
<!-- YAML
913931
added: v18.0.0
932+
changes:
933+
- version: REPLACEME
934+
pr-url: https://github.com/nodejs/node/pull/57510
935+
description: Marking the API stable.
914936
-->
915937

916-
> Stability: 1 - Experimental.
917-
918938
A browser-compatible implementation of [`ReadableStreamDefaultReader`][].
919939

920940
## `require()`
@@ -1067,10 +1087,12 @@ The WHATWG `TextDecoder` class. See the [`TextDecoder`][] section.
10671087

10681088
<!-- YAML
10691089
added: v18.0.0
1090+
changes:
1091+
- version: REPLACEME
1092+
pr-url: https://github.com/nodejs/node/pull/57510
1093+
description: Marking the API stable.
10701094
-->
10711095

1072-
> Stability: 1 - Experimental.
1073-
10741096
A browser-compatible implementation of [`TextDecoderStream`][].
10751097

10761098
## `TextEncoder`
@@ -1087,30 +1109,36 @@ The WHATWG `TextEncoder` class. See the [`TextEncoder`][] section.
10871109

10881110
<!-- YAML
10891111
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.
10901116
-->
10911117

1092-
> Stability: 1 - Experimental.
1093-
10941118
A browser-compatible implementation of [`TextEncoderStream`][].
10951119

10961120
## Class: `TransformStream`
10971121

10981122
<!-- YAML
10991123
added: v18.0.0
1124+
changes:
1125+
- version: REPLACEME
1126+
pr-url: https://github.com/nodejs/node/pull/57510
1127+
description: Marking the API stable.
11001128
-->
11011129

1102-
> Stability: 1 - Experimental.
1103-
11041130
A browser-compatible implementation of [`TransformStream`][].
11051131

11061132
## Class: `TransformStreamDefaultController`
11071133

11081134
<!-- YAML
11091135
added: v18.0.0
1136+
changes:
1137+
- version: REPLACEME
1138+
pr-url: https://github.com/nodejs/node/pull/57510
1139+
description: Marking the API stable.
11101140
-->
11111141

1112-
> Stability: 1 - Experimental.
1113-
11141142
A browser-compatible implementation of [`TransformStreamDefaultController`][].
11151143

11161144
## `URL`
@@ -1171,30 +1199,36 @@ with the [`--no-experimental-websocket`][] CLI flag.
11711199

11721200
<!-- YAML
11731201
added: v18.0.0
1202+
changes:
1203+
- version: REPLACEME
1204+
pr-url: https://github.com/nodejs/node/pull/57510
1205+
description: Marking the API stable.
11741206
-->
11751207

1176-
> Stability: 1 - Experimental.
1177-
11781208
A browser-compatible implementation of [`WritableStream`][].
11791209

11801210
## Class: `WritableStreamDefaultController`
11811211

11821212
<!-- YAML
11831213
added: v18.0.0
1214+
changes:
1215+
- version: REPLACEME
1216+
pr-url: https://github.com/nodejs/node/pull/57510
1217+
description: Marking the API stable.
11841218
-->
11851219

1186-
> Stability: 1 - Experimental.
1187-
11881220
A browser-compatible implementation of [`WritableStreamDefaultController`][].
11891221

11901222
## Class: `WritableStreamDefaultWriter`
11911223

11921224
<!-- YAML
11931225
added: v18.0.0
1226+
changes:
1227+
- version: REPLACEME
1228+
pr-url: https://github.com/nodejs/node/pull/57510
1229+
description: Marking the API stable.
11941230
-->
11951231

1196-
> Stability: 1 - Experimental.
1197-
11981232
A browser-compatible implementation of [`WritableStreamDefaultWriter`][].
11991233

12001234
[CommonJS module]: modules.md

‎doc/api/util.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1553,10 +1553,12 @@ equality.
15531553
added:
15541554
- v19.1.0
15551555
- v18.13.0
1556+
changes:
1557+
- version: REPLACEME
1558+
pr-url: https://github.com/nodejs/node/pull/57510
1559+
description: Marking the API stable.
15561560
-->
15571561

1558-
> Stability: 1 - Experimental
1559-
15601562
An implementation of [the MIMEType class](https://bmeck.github.io/node-proposal-mime-api/).
15611563

15621564
In accordance with browser conventions, all properties of `MIMEType` objects
@@ -2679,21 +2681,25 @@ Unicode "replacement character" U+FFFD.
26792681
26802682
<!-- YAML
26812683
added: v18.11.0
2684+
changes:
2685+
- version: REPLACEME
2686+
pr-url: https://github.com/nodejs/node/pull/57510
2687+
description: Marking the API stable.
26822688
-->
26832689
2684-
> Stability: 1 - Experimental
2685-
26862690
Creates and returns an {AbortController} instance whose {AbortSignal} is marked
26872691
as transferable and can be used with `structuredClone()` or `postMessage()`.
26882692
26892693
## `util.transferableAbortSignal(signal)`
26902694
26912695
<!-- YAML
26922696
added: v18.11.0
2697+
changes:
2698+
- version: REPLACEME
2699+
pr-url: https://github.com/nodejs/node/pull/57510
2700+
description: Marking the API stable.
26932701
-->
26942702
2695-
> Stability: 1 - Experimental
2696-
26972703
* `signal` {AbortSignal}
26982704
* Returns: {AbortSignal}
26992705

0 commit comments

Comments
 (0)