Opal-Estate-Pro/node_modules/user-home/readme.md

43 lines
617 B
Markdown
Raw Normal View History

2019-09-13 06:27:52 +02:00
# 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
```sh
$ 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.
## CLI
```sh
$ npm install --global user-home
```
```sh
$ user-home --help
Example
$ user-home
/Users/sindresorhus
```
## License
MIT © [Sindre Sorhus](http://sindresorhus.com)