Skip to content

doc: clarify os.cpus() returns logical CPU cores #16282

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
lukechilds wants to merge 1 commit into from
Closed

doc: clarify os.cpus() returns logical CPU cores #16282

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
doc: clarify os.cpus() returns logical CPU cores 
Original text implied it returns physical cpu cores. This is misleading
as `os.cpus().length` is often used to get the CPU core count in
Node.js. In reality that will return the thread count which may not be
what the user intended.

Fixes: #16279
  • Loading branch information
@lukechilds
lukechilds authored Oct 18, 2017
commit b13cd9140d8d44a984e2d42b9c6fad6e86ba5f79
2 changes: 1 addition & 1 deletion doc/api/os.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ added: v0.3.3
* Returns: {Array}

The `os.cpus()` method returns an array of objects containing information about
each CPU/core installed.
each logical CPU core.

The properties included on each object include:

Expand Down