From 4a91fa11a3ab16349956ef1a5de912668c125757 Mon Sep 17 00:00:00 2001 From: George Kotchlamazashvili Date: Wed, 29 Jul 2015 02:58:32 +0400 Subject: [PATCH] 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 --- doc/api/os.markdown | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/doc/api/os.markdown b/doc/api/os.markdown index 58a80d074d0042..c8e101353d528d 100644 --- a/doc/api/os.markdown +++ b/doc/api/os.markdown @@ -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()