44 lines
1.3 KiB
Markdown
44 lines
1.3 KiB
Markdown
[](https://www.npmjs.org/package/home-path)
|
|
[](https://www.npmjs.org/package/home-path)
|
|
[](https://travis-ci.org/75lb/home-path)
|
|
[](https://david-dm.org/75lb/home-path)
|
|
[](https://github.com/feross/standard)
|
|
|
|
<a name="module_home-path"></a>
|
|
|
|
# home-path
|
|
Cross-platform home directory retriever, tested on Windows XP and above, Mac OSX and Linux.
|
|
|
|
With node versions 2.3.0 (iojs) or higher, the built-in [`os.homedir`](https://nodejs.org/api/os.html#os_os_homedir) method is used.
|
|
|
|
**Example**
|
|
```js
|
|
var getHomePath = require('home-path')
|
|
```
|
|
<a name="exp_module_home-path--getHomePath"></a>
|
|
|
|
## getHomePath() ⏏
|
|
**Kind**: Exported function
|
|
**Example**
|
|
Mac OSX
|
|
```js
|
|
> getHomePath()
|
|
'/Users/Lloyd'
|
|
```
|
|
|
|
Ubuntu Linux
|
|
```js
|
|
> getHomePath()
|
|
'/home/lloyd'
|
|
```
|
|
|
|
Windows 8.1
|
|
```js
|
|
> getHomePath()
|
|
'C:\\Users\\Lloyd'
|
|
```
|
|
|
|
* * *
|
|
|
|
© 2015-17 Lloyd Brookes \<75pound@gmail.com\>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).
|