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

doc: document os.userInfo() throwing SystemError

Browse Source 
`os.userInfo()` throws an exception which was not documented
in environments like: `docker run --user $(id -u): $(id -g)`.

PR-URL: https://github.com/nodejs/node/pull/25724
Fixes: https://github.com/nodejs/node/issues/25714
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Raido Kuli 2019-01-26 11:31:40 +02:00 committed by Vse Mozhet Byt
parent 3418956349
commit d0bce9a82d
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/api/os.md
View File

@ -451,6 +451,8 @@ system. This differs from the result of `os.homedir()`, which queries several
environment variables for the home directory before falling back to the
operating system response.
Throws a [`SystemError`][] if a user has no `username` or `homedir`.
## OS Constants
The following constants are exported by `os.constants`.
@ -1313,6 +1315,7 @@ The following process scheduling constants are exported by
</tr>
</table>
[`SystemError`]: errors.html#errors_system_errors
[`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