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

Commit 7c43d37

Browse files
committed
doc: Update docs for os.platform()
1 parent cf435d5 commit 7c43d37

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

doc/api/os.markdown

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,11 @@ Returns the operating system name.
2424

2525
## os.platform()
2626

27-
Returns the operating system platform.
27+
Returns the operating system platform. Some of the possible values are `"linux"`, `"darwin"`, `"win32"`, `"sunos"` ...
28+
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+
31+
On Windows its value is always `"win32"`, on Mac OS X its `"darwin"` and on Solaris its `"sunos"`.
2832

2933
## os.arch()
3034

0 commit comments

Comments
 (0)