Skip to content
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.

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

Unclear return type specification of cpus() in OS.md #78

Open
Tracked by #68
pklaschka opened this issue Oct 18, 2022 · 0 comments
Open
Tracked by #68

Unclear return type specification of cpus() in OS.md #78

pklaschka opened this issue Oct 18, 2022 · 0 comments

Comments

@pklaschka
Copy link
Contributor

## cpus()
Gets the platform cpu information we are running on (eg. "{'Intel(R) Core(TM) i9-8950HK CPU @ 2.90GHz', 2900}")
**Returns**: `array` - the array of objects containing information about each logical CPU core
Currently only model and speed properties are supported. times property is not supported.
Access to CPU information, such as model string and frequency, is limited on UWP.
"ARM based architecture" or "X86 based architecture" is returned as a 'model' value on UWP.
0 is returned as a 'speed' value on UWP.

It isn't clear what kind of information is in the array. Even if we don't have a perfect type definition, specifiying that this is an Array<object> (or maybe Array<any>) already increases the understanding that one can get just from reading/scanning this).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant