1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: improve os.homedir() docs

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/28401
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Juan José Arboleda 2019-06-23 22:28:12 -05:00 committed by Rich Trott
parent 3ad87994ec
commit d1bb21fc2c
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/api/os.md
View File

@ -215,6 +215,14 @@ added: v2.3.0
The `os.homedir()` method returns the home directory of the current user as a The `os.homedir()` method returns the home directory of the current user as a
string. string.
**POSIX**:
Will use the `$HOME` environment variable if defined. Otherwise, it will use
the [effective UID][EUID] to look up the user's home directory.
**Windows**:
Will use the `USERPROFILE` environment variable if defined. Otherwise it
will be the path to the profile directory of the current user.
## os.hostname() ## os.hostname()
<!-- YAML <!-- YAML
added: v0.3.3 added: v0.3.3
@ -1319,4 +1327,5 @@ The following process scheduling constants are exported by
[`process.arch`]: process.html#process_process_arch [`process.arch`]: process.html#process_process_arch
[`process.platform`]: process.html#process_process_platform [`process.platform`]: process.html#process_process_platform
[Android building]: https://github.com/nodejs/node/blob/master/BUILDING.md#androidandroid-based-devices-eg-firefox-os [Android building]: https://github.com/nodejs/node/blob/master/BUILDING.md#androidandroid-based-devices-eg-firefox-os
[EUID]: https://en.wikipedia.org/wiki/User_identifier#Effective_user_ID
[uname(3)]: https://linux.die.net/man/3/uname [uname(3)]: https://linux.die.net/man/3/uname