Skip to content

Commit faf5c23

Browse files
cjihrigRafaelGSS
authored andcommitted
doc: add parallelism note to os.cpus()
With the introduction of os.availableParallelism(), users should no longer rely on os.cpus().length to determine the amount of available parallelism. This commit adds a note to the os.cpus() docs. PR-URL: #45895 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
1 parent d71883e commit faf5c23

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

doc/api/os.md

+4
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,10 @@ The properties included on each object include:
140140
`nice` values are POSIX-only. On Windows, the `nice` values of all processors
141141
are always 0.
142142

143+
`os.cpus().length` should not be used to calculate the amount of parallelism
144+
available to an application. Use
145+
[`os.availableParallelism()`](#osavailableparallelism) for this purpose.
146+
143147
## `os.devNull`
144148

145149
<!-- YAML

0 commit comments

Comments
 (0)