global-cache-dir

What is global-cache-dir?

The global-cache-dir npm package provides a way to get the path to a global cache directory. This can be useful for storing and retrieving cached data that is shared across multiple projects or tools.

What are global-cache-dir's main functionalities?

Get Global Cache Directory

This feature allows you to get the path to a global cache directory for your application. The directory is created if it does not already exist. The code sample demonstrates how to use the global-cache-dir package to get the cache directory for an application named 'my-app'.

const globalCacheDir = require('global-cache-dir');

(async () => {
  const cacheDir = await globalCacheDir('my-app');
  console.log(cacheDir);
})();

Other packages similar to global-cache-dir

find-cache-dir

The find-cache-dir package helps you locate a cache directory for your project. It is often used in build tools and other CLI applications to store temporary files. Unlike global-cache-dir, find-cache-dir is more focused on project-specific cache directories rather than global ones.

cache-manager

The cache-manager package provides a more comprehensive caching solution, supporting multiple storage backends like memory, Redis, and more. It is more feature-rich compared to global-cache-dir, which is primarily focused on providing a global cache directory path.

cacache

The cacache package is a high-level cache library for Node.js, used internally by npm. It provides a more complex caching mechanism with features like content-addressable storage. It is more advanced compared to global-cache-dir, which is simpler and more focused on directory paths.

README

Get the global cache directory.

Also ensures the directory exists.

The cache directory location is OS-specific.

Example

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

npm install global-cache-dir

Usage

globalCacheDir(name)

name: {string}
Returns: {Promise<string>}

name must only use digits, letters or dashes.

See also

• node-cachedir: underlying logic for this module
• 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.

For other questions, feel free to chat with us on Gitter.

Everyone is welcome regardless of personal background. We enforce a Code of conduct 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. Pull requests are welcome!

ehmicky 💻 🎨 🤔 📖