Node.js - os.homedir() Method

---

---

The Node.js os.homedir() method returns a string of the path of the home directory of the user. When it comes to LINUX and UNIX operating systems, it will use the variable named $HOME if it is defined. Else, it will take the home directory path by the effective UID, which is the user ID of the user.

Note −

• On POSIX, it gets the value from the environment variable $HOME if it is defined. If not, it returns the home directory for a certain useful UID.

• On Windows, if USERPROFILE is defined as an environment variable on Windows, it gets its value from there. If not, it returns the path of the user's profile directory for the current user.

Syntax

Following is the syntax of the Node.js homedir() method of os module −

os.homedir()

Parameters

This method does not accept any parameters.

Return value

This method will return the path of the current user's home directory as a string.

Example

In the following example, we are trying to print the home directory of the current user by using Node.js os.homedir() method of os module.

const os = require('os');
console.log(os.homedir());

Output

/tmp

Note − To get the accurate result, better execute the above code in local.

After executing the above program, the os.homedir() returned the path of the home directory of the user.

C:\Users\Lenovo

Example

In this example, we are trying to implement another way to get the home directory of the user.

const os = require('os');
function getUserHome() {
   return process.env.HOME || process.env.USERPROFILE;
  }
console.log(getUserHome());

Output

/tmp

Note − To get the accurate result, better execute the above code in local.

If we compile and run the above program, we get the home directory of the current operating system.

C:\Users\Lenovo