From d0bce9a82d820df9b297de58881fb00a57f6775c Mon Sep 17 00:00:00 2001 From: Raido Kuli Date: Sat, 26 Jan 2019 11:31:40 +0200 Subject: 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 --- doc/api/os.md | 3 +++ 1 file changed, 3 insertions(+) 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 +[`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 -- cgit v1.2.3