Skip to content

Docs: should give a descriptive information about the process.platform property & os.platform() function #41650

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

Merged
merged 1 commit into from
Jan 28, 2022
Merged

Docs: should give a descriptive information about the process.platform property & os.platform() function #41650

Show file tree
Hide file tree
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
7 changes: 4 additions & 3 deletions doc/api/os.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,9 +301,10 @@ added: v0.5.0

* Returns: {string}

Returns a string identifying the operating system platform. The value is set
at compile time. Possible values are `'aix'`, `'darwin'`, `'freebsd'`,
`'linux'`, `'openbsd'`, `'sunos'`, and `'win32'`.
Returns a string identifying the operating system platform for which
the Node.js binary was compiled. The value is set at compile time.
Possible values are `'aix'`, `'darwin'`, `'freebsd'`,`'linux'`,
`'openbsd'`, `'sunos'`, and `'win32'`.

The return value is equivalent to [`process.platform`][].

Expand Down
2 changes: 1 addition & 1 deletion doc/api/process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2613,7 +2613,7 @@ added: v0.1.16
* {string}

The `process.platform` property returns a string identifying the operating
system platform on which the Node.js process is running.
system platform for which the Node.js binary was compiled.

Currently possible values are:

Expand Down