Skip to content

Commit 5c5aa49

Browse files
marswongevanlucas
authored andcommitted
doc: improve process.platform
PR-URL: #18057 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent 61df843 commit 5c5aa49

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

doc/api/process.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -1439,13 +1439,26 @@ added: v0.1.16
14391439
* {string}
14401440

14411441
The `process.platform` property returns a string identifying the operating
1442-
system platform on which the Node.js process is running. For instance
1443-
`'darwin'`, `'freebsd'`, `'linux'`, `'sunos'` or `'win32'`
1442+
system platform on which the Node.js process is running.
1443+
1444+
Currently possible values are:
1445+
1446+
* `'aix'`
1447+
* `'darwin'`
1448+
* `'freebsd'`
1449+
* `'linux'`
1450+
* `'openbsd'`
1451+
* `'sunos'`
1452+
* `'win32'`
14441453

14451454
```js
14461455
console.log(`This platform is ${process.platform}`);
14471456
```
14481457

1458+
The value `'android'` may also be returned if the Node.js is built on the
1459+
Android operating system. However, Android support in Node.js
1460+
[is experimental][Supported platforms].
1461+
14491462
## process.ppid
14501463
<!-- YAML
14511464
added: v9.2.0
@@ -2017,5 +2030,6 @@ cases:
20172030
[Readable]: stream.html#stream_readable_streams
20182031
[Signal Events]: #process_signal_events
20192032
[Stream compatibility]: stream.html#stream_compatibility_with_older_node_js_versions
2033+
[Supported platforms]: https://github.com/nodejs/node/blob/master/BUILDING.md#supported-platforms-1
20202034
[TTY]: tty.html#tty_tty
20212035
[Writable]: stream.html#stream_writable_streams

0 commit comments

Comments
 (0)