From fac23682232dc111a5fab8b1c6370ea1d5d1d096 Mon Sep 17 00:00:00 2001 From: cjihrig Date: Sun, 18 Dec 2022 10:37:11 -0500 Subject: [PATCH] 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. --- doc/api/os.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/api/os.md b/doc/api/os.md index 91507e05e68bb5..ae1baf78e864d0 100644 --- a/doc/api/os.md +++ b/doc/api/os.md @@ -138,6 +138,10 @@ The properties included on each object include: `nice` values are POSIX-only. On Windows, the `nice` values of all processors are always 0. +`os.cpus().length` should not be used to calculate the amount of parallelism +available to an application. Use +[`os.availableParallelism()`](#osavailableparallelism) for this purpose. + ## `os.devNull`