Skip to content

Commit 511d610

Browse files
jsmrcagatargos
authored andcommitted
doc: updated docs to include --experimental-worker flag
Updated worker-threads.md, cli.md and node.1 to include --experimental-worker flag PR-URL: #21461 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]>
1 parent 97b2186 commit 511d610

File tree

3 files changed

+11
-1
lines changed

3 files changed

+11
-1
lines changed

doc/api/cli.md

+7
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,13 @@ added: v9.6.0
8181

8282
Enable experimental ES Module support in the `vm` module.
8383

84+
### `--experimental-worker`
85+
<!-- YAML
86+
added: v10.5.0
87+
-->
88+
89+
Enable experimental worker threads using the `worker_threads` module.
90+
8491
### `--force-fips`
8592
<!-- YAML
8693
added: v6.0.0

doc/api/worker_threads.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
77
The `worker` module provides a way to create multiple environments running
88
on independent threads, and to create message channels between them. It
9-
can be accessed using:
9+
can be accessed using the `--experimental-worker` flag and:
1010

1111
```js
1212
const worker = require('worker_threads');

doc/node.1

+3
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,9 @@ keyword support in REPL.
9191
.It Fl -experimental-vm-modules
9292
Enable experimental ES module support in VM module.
9393
.
94+
.It Fl -experimental-worker
95+
Enable experimental worker threads using worker_threads module.
96+
.
9497
.It Fl -force-fips
9598
Force FIPS-compliant crypto on startup
9699
(Cannot be disabled from script code).

0 commit comments

Comments
 (0)