Node.js process.setgid() Method

The process.setgid() method is an inbuilt application programming interface of the process module which is used to set the group identity of the Node.js process.
Syntax:

process.setgid(id)

Parameters: This method accepts single parameter as mentioned above and described below:

id: It is a required parameter that holds a String or an integer denotes either groupname or ID, if group name is passed, it blocks while resolving the associated numeric ID.

Return: It does not return any value.
Note: This function will only work on POSIX platforms. Not available on windows or android platforms so will cause an error i.e. TypeError, setgid is not a function.
Below examples illustrate the use of process.setgid() method in Node.js:
Example 1:

javascript

// Node.js program to demonstrate the     
// process.setgid() Method
 
// Including process module
const process = require('process');

// Printing the group identity of
// the Node.js process that checks
// whether the methods exists or not
if (process.getgid && process.setgid ) {
    
  // Setting gid
  process.setgid(400);
  
  // Printing getgid() value
  console.log("The group identity of the Node.js"
      + " process:", process.getgid());
}

Output:

The group identity of the Node.js process: 400

Example 2:

javascript

// Node.js program to demonstrate the     
// process.setgid() Method
 
// Including process module
const process = require('process');

// Set gid and check whether the
// method exists or not
if (process.setgid) {
  
  // Within try catch
  try {
    process.setgid(696);
    console.log("gid has successfully been set");
  } catch (err) {
    console.log("Failed to set gid:", err);
  }
}

// Check whether the method exists or not
if (process.getgid) {
  
  // Printing getgid() value
  console.log("The group identity of the Node.js"
      + " process:", process.getgid());
}

Output:

gid has successfully been set
The group identity of the Node.js process: 696

Note: The above program will compile and run by using the node filename.js command.
Reference: https://nodejs.org/api/process.html#process_process_setgid_id

Node.js process.setgid() Method

Explore