diff options
| author | Harshil jain <twitharshil@gmail.com> | 2022-01-28 03:12:01 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-28 03:12:01 +0300 |
| commit | a4183b666e3a3f8eafaba5acd09e4d3dd39c5e1c (patch) | |
| tree | 37eac794497b6cd66edf87f30bb06f8af50cf62a /doc/api/os.md | |
| parent | 40ef144b6531e08a26f2690e1f3b6f429ba0cf08 (diff) | |
doc: improve docs to give descriptive info for the platform property
PR-URL: https://github.com/nodejs/node/pull/41650
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Tierney Cyren <hello@bnb.im>
Diffstat (limited to 'doc/api/os.md')
| -rw-r--r-- | doc/api/os.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/api/os.md b/doc/api/os.md index 19d0528b0ea..99c448a4b90 100644 --- a/doc/api/os.md +++ b/doc/api/os.md @@ -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`][]. |