Skip to content

Commit

Permalink
doc: Update docs for os.platform()
Browse files Browse the repository at this point in the history
Specifies origin and includes a list of possible values

PR-URL: nodejs/node-v0.x-archive#25777
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
hertzg authored and jasnell committed Aug 19, 2015
1 parent 15030f2 commit 4a91fa1
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion doc/api/os.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,25 @@ Returns the operating system name.

## 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()

Expand Down

0 comments on commit 4a91fa1

Please sign in to comment.