Skip to content
This repository was archived by the owner on Apr 22, 2023. It is now read-only.

Commit ebff733

Browse files
committed
doc: Wraps lines at 80 chars and includes a list of possible values for os.platform()
1 parent 7c43d37 commit ebff733

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

doc/api/os.markdown

+17-3
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,25 @@ Returns the operating system name.
2424

2525
## os.platform()
2626

27-
Returns the operating system platform. Some of the possible values are `"linux"`, `"darwin"`, `"win32"`, `"sunos"` ...
27+
Returns the operating system platform. Some of the possible values are
28+
`"linux"`, `"darwin"`, `"win32"`, `"sunos"` ...
2829

29-
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.
30+
Its value is based on [`OS` constant of `gyp`](https://chromium.googlesource.com/external/gyp/+/HEAD/docs/InputFormatReference.md#Predefined-Variables)
31+
, but with exceptions in case of Mac OS X, Windows and Solaris.
3032

31-
On Windows its value is always `"win32"`, on Mac OS X its `"darwin"` and on Solaris its `"sunos"`.
33+
On Windows its value is always `"win32"`, on Mac OS X its `"darwin"` and on
34+
Solaris its `"sunos"`.
35+
36+
Heres a list of possible values for some platforms:
37+
38+
* Android: `"android"`
39+
* Windows/Cygwin: `"win32"`
40+
* Mac OS X: `"darwin"`
41+
* FreeBSD: `"freebsd"`
42+
* OpenBSD: `"openbsd"`
43+
* IBM AIX: `"aix"`
44+
* Solaris: `"sunos"`
45+
* Linux & Others: `"linux"`
3246

3347
## os.arch()
3448

0 commit comments

Comments
 (0)