doc: add a note about os.cpus() returning an empty list

It is not obvious that in some cases cpus() returns an empty list and this has caused a bug before: isaacs/promise-call-limit#11
codedokode · Apr 3, 2023 · 7303d96 · 7303d96
1 parent a00137e
commit 7303d96
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/doc/api/os.md b/doc/api/os.md
@@ -76,6 +76,8 @@ added: v0.3.3
 * Returns: {Object\[]}
 
 Returns an array of objects containing information about each logical CPU core.
+The array will be empty if no CPU information is available, such as if the
+`/proc` filesystem is unavailable.
 
 The properties included on each object include: