Blame view

node_modules/user-home/readme.md 724 Bytes
f7563de62   Palak Handa   first commit
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
  # user-home [![Build Status](https://travis-ci.org/sindresorhus/user-home.svg?branch=master)](https://travis-ci.org/sindresorhus/user-home)
  
  > Get the path to the user home directory
  
  
  ## Install
  
  ```
  $ npm install --save user-home
  ```
  
  
  ## Usage
  
  ```js
  var userHome = require('user-home');
  
  console.log(userHome);
  //=> '/Users/sindresorhus'
  ```
  
  Returns `null` in the unlikely scenario that the home directory can't be found.
  
  
  ## Related
  
  - [user-home-cli](https://github.com/sindresorhus/user-home-cli) - CLI for this module
  - [home-or-tmp](https://github.com/sindresorhus/home-or-tmp) - Get the user home directory with fallback to the system temp directory
  
  
  ## License
  
  MIT © [Sindre Sorhus](http://sindresorhus.com)