[](https://codecov.io/gh/ehmicky/global-cache-dir)
[](https://travis-ci.org/ehmicky/global-cache-dir)
[](https://www.npmjs.com/package/global-cache-dir)
[](https://gitter.im/ehmicky/global-cache-dir)
[](https://twitter.com/intent/follow?screen_name=ehmicky)
[](https://medium.com/@ehmicky)
Get the global cache directory.
Ensures the directory exists.
The cache directory location is OS-specific.
# Example
```js
const globalCacheDir = require('global-cache-dir')
const cacheDir = await globalCacheDir('myapp')
// Depending on the OS:
// => '/Users/ehmicky/Library/Caches/myapp'
// => '/home/ehmicky/.cache/myapp'
// => 'C:\Users\ehmicky\AppData\Local\myapp\Cache'
```
# Install
```bash
npm install global-cache-dir
```
# Usage
## globalCacheDir(name)
`name`: `string`
_Returns_: `Promise`
`name` must only use digits, letters or dashes.
# See also
- [`node-cachedir`](https://github.com/LinusU/node-cachedir): underlying logic
for this module
- [`find-cache-dir`](https://github.com/avajs/find-cache-dir): get the local
cache directory
# Support
If you found a bug or would like a new feature, _don't hesitate_ to
[submit an issue on GitHub](../../issues).
For other questions, feel free to
[chat with us on Gitter](https://gitter.im/ehmicky/global-cache-dir).
Everyone is welcome regardless of personal background. We enforce a
[Code of conduct](CODE_OF_CONDUCT.md) in order to promote a positive and
inclusive environment.
# Contributing
This project was made with ❤️. The simplest way to give back is by starring and
sharing it online.
If the documentation is unclear or has a typo, please click on the page's `Edit`
button (pencil icon) and suggest a correction.
If you would like to help us fix a bug or add a new feature, please check our
[guidelines](CONTRIBUTING.md). Pull requests are welcome!
