Skip to content

doc: include undefined in os.cpus() return values #24408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Trott wants to merge 2 commits into from
Closed

doc: include undefined in os.cpus() return values #24408

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e802ae3
doc: include undefined in os.cpus() return values
Trott Nov 17, 2018
79044ef
fixup! doc: include undefined in os.cpus() return values
Trott Nov 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
doc: include undefined in os.cpus() return values 
Document that `os.cpus()` can return `undefined` if information about
cores is not available. This can happen particularly on unsupported
platforms like Android.

Fixes: #19022
  • Loading branch information
@Trott
Trott committed Nov 17, 2018
commit e802ae32421f40c7d6434445fa81bb682e69975c
6 changes: 3 additions & 3 deletions doc/api/os.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@ defined are described in [OS Constants](#os_os_constants_1).
added: v0.3.3
-->

* Returns: {Object[]}
* Returns: {Object[]|undefined}

The `os.cpus()` method returns an array of objects containing information about
each logical CPU core.
Returns an array of objects containing information about each logical CPU core.
If the information is not available, `os.cpus()` will return `undefined`.

The properties included on each object include:

Expand Down