Skip to content

doc: improve os.homedir() docs #28401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

doc: improve os.homedir() docs #28401

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc: improve os.homedir() docs
  • Loading branch information
@juanarbol @Trott
juanarbol authored and Trott committed Jul 18, 2019
commit f432a8cfe7077fa12d618aa17da108548d14e69f
9 changes: 9 additions & 0 deletions doc/api/os.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,14 @@ added: v2.3.0
The `os.homedir()` method returns the home directory of the current user as a
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()
<!-- YAML
added: v0.3.3
Expand Down Expand Up @@ -1319,4 +1327,5 @@ The following process scheduling constants are exported by
[`process.arch`]: process.html#process_process_arch
[`process.platform`]: process.html#process_process_platform
[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
Copy link
Member Author

@juanarbol juanarbol Jul 13, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Trott Reordered by ASCII !

[uname(3)]: https://linux.die.net/man/3/uname