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: #25724 Fixes: #25714 Reviewed-By: James M Snell <[email protected]>
nodejs · Feb 3, 2019 · 1f6acbb · 1f6acbb
1 parent c4e2bbb
commit 1f6acbb
Showing 1 changed file with 3 additions and 0 deletions.
diff --git 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:/nodejs/node/blob/master/BUILDING.md#androidandroid-based-devices-eg-firefox-os