https://github.com/saqqdy/userdir
A simple utility to get the cross-platform user home directory
https://github.com/saqqdy/userdir
cross-platform home homedir userdir userhome
Last synced: 3 days ago
JSON representation
A simple utility to get the cross-platform user home directory
- Host: GitHub
- URL: https://github.com/saqqdy/userdir
- Owner: saqqdy
- License: mit
- Created: 2023-02-13T01:21:14.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-05-08T23:02:59.000Z (over 2 years ago)
- Last Synced: 2025-09-07T03:51:26.241Z (29 days ago)
- Topics: cross-platform, home, homedir, userdir, userhome
- Language: TypeScript
- Homepage:
- Size: 259 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# userdir
A simple utility to get the cross-platform user home directory
[![NPM version][npm-image]][npm-url]
[![Codacy Badge][codacy-image]][codacy-url]
[![Test coverage][codecov-image]][codecov-url]
[![npm download][download-image]][download-url]
[![License][license-image]][license-url][![Sonar][sonar-image]][sonar-url]
## **For API documentation, see: [API Docs](./docs/modules.md)**
## Installing
```bash
# use pnpm
$ pnpm install userdir# use npm
$ npm install userdir --save# use yarn
$ yarn add userdir
```## Usage
```js
import userdir from 'userdir'userdir() // /Users/saqqdy
```## Support & Issues
Please open an issue [here](https://github.com/saqqdy/userdir/issues).
## License
[MIT](LICENSE)
[npm-image]: https://img.shields.io/npm/v/userdir.svg?style=flat-square
[npm-url]: https://npmjs.org/package/userdir
[codacy-image]: https://app.codacy.com/project/badge/Grade/f70d4880e4ad4f40aa970eb9ee9d0696
[codacy-url]: https://www.codacy.com/gh/saqqdy/userdir/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saqqdy/userdir&utm_campaign=Badge_Grade
[codecov-image]: https://img.shields.io/codecov/c/github/saqqdy/userdir.svg?style=flat-square
[codecov-url]: https://codecov.io/github/saqqdy/userdir?branch=master
[download-image]: https://img.shields.io/npm/dm/userdir.svg?style=flat-square
[download-url]: https://npmjs.org/package/userdir
[license-image]: https://img.shields.io/badge/License-MIT-blue.svg
[license-url]: LICENSE
[sonar-image]: https://sonarcloud.io/api/project_badges/quality_gate?project=saqqdy_userdir
[sonar-url]: https://sonarcloud.io/dashboard?id=saqqdy_userdir