Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ehmicky/global-cache-dir
Get the global cache directory
https://github.com/ehmicky/global-cache-dir
android bsd cache caching directory es6 files filesystem global javascript library linux mac macos nodejs operating-system path performance typescript windows
Last synced: 3 months ago
JSON representation
Get the global cache directory
- Host: GitHub
- URL: https://github.com/ehmicky/global-cache-dir
- Owner: ehmicky
- License: mit
- Created: 2019-08-09T16:28:14.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-14T16:52:57.000Z (5 months ago)
- Last Synced: 2024-10-11T10:17:05.255Z (4 months ago)
- Topics: android, bsd, cache, caching, directory, es6, files, filesystem, global, javascript, library, linux, mac, macos, nodejs, operating-system, path, performance, typescript, windows
- Language: JavaScript
- Homepage:
- Size: 8.54 MB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-cross-platform-nodejs - global-cache-dir - Get the global OS-specific cache directory. (Libraries / Filesystem)
README
[](https://www.npmjs.com/package/global-cache-dir)
[](/src/main.d.ts)
[](https://codecov.io/gh/ehmicky/global-cache-dir)
[](https://fosstodon.org/@ehmicky)
[](https://medium.com/@ehmicky)
Get the global cache directory.
Ensures the directory exists.
The cache directory location is OS-specific.
# Hire me
Please
[reach out](https://www.linkedin.com/feed/update/urn:li:activity:7117265228068716545/)
if you're looking for a Node.js API or CLI engineer (11 years of experience).
Most recently I have been [Netlify Build](https://github.com/netlify/build)'s
and [Netlify Plugins](https://www.netlify.com/products/build/plugins/)'
technical lead for 2.5 years. I am available for full-time remote positions.
# Example
```js
import globalCacheDir from '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
```
This package works in Node.js >=18.18.0.
This is an ES module. It must be loaded using
[an `import` or `import()` statement](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c),
not `require()`. If TypeScript is used, it must be configured to
[output ES modules](https://www.typescriptlang.org/docs/handbook/esm-node.html),
not CommonJS.
# 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
For any question, _don't hesitate_ to [submit an issue on GitHub](../../issues).
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!