Skip to content

Commit c659add

Browse files
aduh95marco-ippolito
authored andcommitted
doc,src,lib: clarify experimental status of Web Storage support
PR-URL: #60708 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Paolo Insogna <paolo@cowtech.it>
1 parent 0e407a8 commit c659add

File tree

2 files changed

+14
-8
lines changed

2 files changed

+14
-8
lines changed

doc/api/cli.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1254,7 +1254,9 @@ Enable experimental WebAssembly System Interface (WASI) support.
12541254
added: v22.4.0
12551255
-->
12561256

1257-
Enable experimental [`Web Storage`][] support.
1257+
> Stability: 1.2 - Release candidate.
1258+
1259+
Enable [`Web Storage`][] support.
12581260

12591261
### `--experimental-worker-inspection`
12601262

@@ -1683,10 +1685,11 @@ surface on other platforms, but the performance impact may be severe.
16831685
added: v22.4.0
16841686
-->
16851687

1688+
> Stability: 1.2 - Release candidate. Enable this API with [`--experimental-webstorage`][].
1689+
16861690
The file used to store `localStorage` data. If the file does not exist, it is
16871691
created the first time `localStorage` is accessed. The same file may be shared
1688-
between multiple Node.js processes concurrently. This flag is a no-op unless
1689-
Node.js is started with the `--experimental-webstorage` flag.
1692+
between multiple Node.js processes concurrently.
16901693

16911694
### `--max-http-header-size=size`
16921695

@@ -3997,6 +4000,7 @@ node --stack-trace-limit=12 -p -e "Error.stackTraceLimit" # prints 12
39974000
[`--experimental-addon-modules`]: #--experimental-addon-modules
39984001
[`--experimental-default-type=module`]: #--experimental-default-typetype
39994002
[`--experimental-sea-config`]: single-executable-applications.md#generating-single-executable-preparation-blobs
4003+
[`--experimental-webstorage`]: #--experimental-webstorage
40004004
[`--heap-prof-dir`]: #--heap-prof-dir
40014005
[`--import`]: #--importmodule
40024006
[`--no-experimental-strip-types`]: #--no-experimental-strip-types

doc/api/globals.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -606,13 +606,12 @@ A browser-compatible implementation of {Headers}.
606606
added: v22.4.0
607607
-->
608608

609-
> Stability: 1.0 - Early development.
609+
> Stability: 1.2 - Release candidate. Enable this API with [`--experimental-webstorage`][].
610610
611611
A browser-compatible implementation of [`localStorage`][]. Data is stored
612612
unencrypted in the file specified by the [`--localstorage-file`][] CLI flag.
613613
The maximum amount of data that can be stored is 10 MB.
614614
Any modification of this data outside of the Web Storage API is not supported.
615-
Enable this API with the [`--experimental-webstorage`][] CLI flag.
616615
`localStorage` data is not stored per user or per request when used in the context
617616
of a server, it is shared across all users and requests.
618617

@@ -974,9 +973,13 @@ A browser-compatible implementation of {Request}.
974973

975974
<!-- YAML
976975
added: v22.4.0
976+
changes:
977+
- version: v25.0.0
978+
pr-url: https://github.com/nodejs/node/pull/57666
979+
description: This API is no longer behind `--experimental-webstorage` runtime flag.
977980
-->
978981

979-
> Stability: 1.0 - Early development.
982+
> Stability: 1.2 - Release candidate. Enable this API with [`--experimental-webstorage`][].
980983
981984
A browser-compatible implementation of [`sessionStorage`][]. Data is stored in
982985
memory, with a storage quota of 10 MB. `sessionStorage` data persists only within
@@ -1012,8 +1015,7 @@ added: v0.0.1
10121015
added: v22.4.0
10131016
-->
10141017

1015-
> Stability: 1.0 - Early development. Enable this API with the
1016-
> [`--experimental-webstorage`][] CLI flag.
1018+
> Stability: 1.2 - Release candidate. Enable this API with [`--experimental-webstorage`][].
10171019
10181020
A browser-compatible implementation of {Storage}.
10191021

0 commit comments

Comments
 (0)