The 'user-home' npm package is a simple utility that provides the path to the current user's home directory. It is useful for applications that need to store or access user-specific configuration files or data.
Get User Home Directory
This feature allows you to retrieve the path to the current user's home directory. The code sample demonstrates how to use the 'user-home' package to log the home directory path to the console.
const userHome = require('user-home');
console.log(userHome);The 'os-homedir' package provides similar functionality by returning the home directory of the current user. It is a lightweight alternative to 'user-home' and is part of the 'os' module in Node.js.
The 'os' module is a built-in Node.js module that provides operating system-related utility methods and properties. The 'os.homedir()' method can be used to get the current user's home directory, making it a direct alternative to 'user-home'.
Deprecated. Just use import {homedir} from 'os';.
Get the path to the user home directory
$ npm install user-home
const userHome = require('user-home');
console.log(userHome);
//=> '/Users/sindresorhus'
Returns null in the unlikely scenario that the home directory can't be found.
os-home module?This module was made long before os-homedir. When Node.js decided to add a native method for getting the user's home directory, I made a polyfill matching its API and decided to depend on it here, so not to have duplicate code. The main reason this one is still around is that lots of modules depend on it and I see no reason to inconvenience dependents by deprecating this. This one also gets the home directory on startup and returns a string rather than exposing a method, so it's faster, and I prefer this API. Modules are cheap in Node.js, so doesn't matter. Use whichever you prefer. I'm going to continue using this one.
FAQs
Get the path to the user home directory
The npm package user-home receives a total of 3,125,458 weekly downloads. As such, user-home popularity was classified as popular.
We found that user-home demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ECMAScript 2025 introduces Iterator Helpers, Set methods, JSON modules, and more in its latest spec update approved by Ecma in June 2025.
Security News
A new Node.js homepage button linking to paid support for EOL versions has sparked a heated discussion among contributors and the wider community.
Research
North Korean threat actors linked to the Contagious Interview campaign return with 35 new malicious npm packages using a stealthy multi-stage malware loader.