diff --git a/doc/api/process.md b/doc/api/process.md index 12b4c9a6d6b03b..9a1eec3d5a973a 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -1966,6 +1966,36 @@ if (process.getuid) { This function is only available on POSIX platforms (i.e. not Windows or Android). +## `process.getresuid()` + + + +The `process.getresuid()` method returns an array with the real, effective, +and saved user IDs. + +* Returns: {integer\[]} + +```mjs +import process from 'process'; + +if (process.getresuid) { + console.log(process.getresuid()); // [ 0, 0, 0 ] +} +``` + +```cjs +const process = require('process'); + +if (process.getresuid) { + console.log(process.getresuid()); // [ 0, 0, 0 ] +} +``` + +This function is only available on POSIX platforms (i.e. not Windows or +Android). + ## `process.hasUncaughtExceptionCaptureCallback()` + +The `process.setresuid(ruid, euid, suid)` method sets the real, effective, +and saved user IDs. + +* `ruid` {string|number} The real user ID +* `euid` {string|number} The effective user ID +* `suid` {string|number} The saved user ID + +```mjs +import process from 'process'; + +if (process.getresuid && process.setresuid) { + console.log(`Current ids: ${process.getresuid()[0]}`); + try { + process.setresuid(501, 501, 501); + console.log(`New ids: ${process.getresuid()}`); + } catch (err) { + console.log(`Failed to set ids: ${err}`); + } +} +``` + +```cjs +const process = require('process'); + +if (process.getresuid && process.setresuid) { + console.log(`Current ids: ${process.getresuid()[0]}`); + try { + process.setresuid(501, 501, 501); + console.log(`New ids: ${process.getresuid()}`); + } catch (err) { + console.log(`Failed to set ids: ${err}`); + } +} +``` + +This function is only available on POSIX platforms (i.e. not Windows or +Android). +This feature is not available in [`Worker`][] threads. + ## `process.setSourceMapsEnabled(val)`