Browse Source

doc: Update docs for os.platform()

Specifies origin and includes a list of possible values

PR-URL: https://github.com/joyent/node/pull/25777
Reviewed-By: James M Snell <jasnell@gmail.com>
v0.12-staging
George Kotchlamazashvili 10 years ago
committed by James M Snell
parent
commit
4a91fa11a3
  1. 20
      doc/api/os.markdown

20
doc/api/os.markdown

@ -24,7 +24,25 @@ Returns the operating system name.
## os.platform() ## os.platform()
Returns the operating system platform. Returns the operating system platform. Some of the possible values are
`"linux"`, `"darwin"`, `"win32"`, `"sunos"` ...
Its value is based on [`OS` constant of `gyp`](https://chromium.googlesource.com/external/gyp/+/HEAD/docs/InputFormatReference.md#Predefined-Variables)
, but with exceptions in case of Mac OS X, Windows and Solaris.
On Windows its value is always `"win32"`, on Mac OS X its `"darwin"` and on
Solaris its `"sunos"`.
Heres a list of possible values for some platforms:
* Android: `"android"`
* Windows/Cygwin: `"win32"`
* Mac OS X: `"darwin"`
* FreeBSD: `"freebsd"`
* OpenBSD: `"openbsd"`
* IBM AIX: `"aix"`
* Solaris: `"sunos"`
* Linux & Others: `"linux"`
## os.arch() ## os.arch()

Loading…
Cancel
Save