doc: add a example code to API doc property

example code added to the process.setgroups() API doc property in process.md PR-URL: #35738 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>
nodejs · Dec 15, 2020 · 4dc5e4a · 4dc5e4a
1 parent ec9fae9
commit 4dc5e4a
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/doc/api/process.md b/doc/api/process.md
@@ -2185,7 +2185,18 @@ The `process.setgroups()` method sets the supplementary group IDs for the
 Node.js process. This is a privileged operation that requires the Node.js
 process to have `root` or the `CAP_SETGID` capability.
 
-The `groups` array can contain numeric group IDs, group names or both.
+The `groups` array can contain numeric group IDs, group names, or both.
+
+```js
+if (process.getgroups && process.setgroups) {
+  try {
+    process.setgroups([501]);
+    console.log(process.getgroups()); // new groups
+  } catch (err) {
+    console.log(`Failed to set groups: ${err}`);
+  }
+}
+```
 
 This function is only available on POSIX platforms (i.e. not Windows or
 Android).