Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

global-cache-dir

ehmicky443.6kMIT6.0.1TypeScript support: included

Get the global cache directory

cache, caching, directory, filesystem, operating-system, global, performance, files, path, javascript, typescript, es6, library, windows, mac, macos, linux, bsd, android, nodejs

readme

Node TypeScript Codecov Mastodon Medium

Get the global cache directory.

Ensures the directory exists.

The cache directory location is OS-specific.

Example

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

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, not require(). If TypeScript is used, it must be configured to output ES modules, not CommonJS.

Usage

globalCacheDir(name)

name: string\ Returns: Promise<string>

name must only use digits, letters or dashes.

See also

Support

For any question, don't hesitate to submit an issue on GitHub.

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!

changelog

6.0.1

Documentation

  • Update README.md

6.0.0

Breaking changes

  • Minimal supported Node.js version is now 18.18.0

5.0.0

Breaking changes

  • Minimal supported Node.js version is now 16.17.0

4.4.0

Features

  • Improve tree-shaking support

4.3.1

Bug fixes

  • Fix package.json

4.3.0

  • Switch to MIT license

4.2.0

Features

  • Reduce npm package size

4.1.0

Features

  • Add TypeScript types

4.0.0

Breaking changes

  • Minimal supported Node.js version is now 14.18.0

3.0.1

Bug fixes

  • Fix main field in package.json

3.0.0

Breaking changes

  • Minimal supported Node.js version is now 12.20.0
  • This package is now an ES module. It can only be loaded with an import or import() statement, not require(). See this post for more information.

2.0.0

Breaking changes

  • Minimal supported Node.js version is now 10.17.0

Features

  • Add support for AIX, NetBSD and SunOS platforms. Fallback to POSIX for other platforms.