# home-path

> Cross-platform home directory retriever

Latest version **1.0.7** (published 2019-09-15) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install home-path
pnpm add home-path
yarn add home-path
bun add home-path
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2019-09-15 |
| First published | 2014-06-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Lloyd Brookes |
| Maintainers | 75lb |
| Keywords | home, directory, folder, path |

## Links

- npm: https://www.npmjs.com/package/home-path
- Repository: https://github.com/75lb/home-path
- Homepage: https://github.com/75lb/home-path#readme
- Issues: https://github.com/75lb/home-path/issues
- npm.io page: https://npm.io/package/home-path

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 1.0.7 (latest) — 2019-09-15
- 1.0.6 — 2018-05-12
- 1.0.5 — 2017-03-30
- 1.0.4 — 2017-03-30
- 1.0.3 — 2016-02-29
- 1.0.2 — 2016-02-15
- 1.0.1 — 2015-09-25
- 1.0.0 — 2015-06-28
- 0.1.2 — 2015-05-13
- 0.1.1 — 2014-06-07
- 0.1.0 — 2014-06-07

## README

[![view on npm](http://img.shields.io/npm/v/home-path.svg)](https://www.npmjs.org/package/home-path)
[![npm module downloads](http://img.shields.io/npm/dt/home-path.svg)](https://www.npmjs.org/package/home-path)
[![Build Status](https://travis-ci.org/75lb/home-path.svg?branch=master)](https://travis-ci.org/75lb/home-path)
[![Dependency Status](https://badgen.net/david/dep/75lb/home-path)](https://david-dm.org/75lb/home-path)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](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'
```

* * *

&copy; 2015-19 Lloyd Brookes \<75pound@gmail.com\>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).

---
_Source: https://npm.io/package/home-path · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._