diff options
| author | Raido Kuli <raido357@gmail.com> | 2019-01-26 11:31:40 +0200 |
|---|---|---|
| committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2019-02-03 13:44:06 +0200 |
| commit | d0bce9a82d820df9b297de58881fb00a57f6775c (patch) | |
| tree | 2786c99cd4b7f3ed49111fb3f8a17a30915025f3 /doc | |
| parent | 34189563496a7d418382ac402241d4970b32b78b (diff) | |
| download | android-node-v8-d0bce9a82d820df9b297de58881fb00a57f6775c.tar.gz android-node-v8-d0bce9a82d820df9b297de58881fb00a57f6775c.tar.bz2 android-node-v8-d0bce9a82d820df9b297de58881fb00a57f6775c.zip | |
doc: document os.userInfo() throwing SystemError
`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>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/os.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/api/os.md b/doc/api/os.md index 5ba1958bd9..0a71dff7f7 100644 --- a/doc/api/os.md +++ b/doc/api/os.md @@ -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 |