@visulima/find-cache-dir

visulima find-cache-dir

Finds the common standard cache directory, a commonjs and esm version of find-cache-dir.

---

^{Daniel Bannert's open source work is supported by the community on GitHub Sponsors}

---

Install

npm install @visulima/find-cache-dir

yarn add @visulima/find-cache-dir

pnpm add @visulima/find-cache-dir

Usage

import { findCacheDir, findCacheDirSync } from "@visulima/find-cache-dir";

const cacheDir = await findCacheDir("my-app");

console.log(cacheDir); //=> '/Users/test/Library/node_mdules/.cache/my-app'

const syncCacheDir = findCacheDirSync("my-app");

console.log(syncCacheDir); //=> '/Users/test/Library/node_mdules/.cache/my-app'

The same can be done for cjs:

const { findCacheDir, findCacheDirSync } = require("@visulima/find-cache-dir");

const cacheDir = findCacheDir("my-app");

console.log(cacheDir); //=> '/Users/test/Library/node_mdules/.cache/my-app'

const syncCacheDir = findCacheDirSync("my-app");

console.log(syncCacheDir); //=> '/Users/test/Library/node_mdules/.cache/my-app'

API

name

Required
Type: string

Should be the same as your project name in package.json.

options

Type: object

cwd

Type: string
Default process.cwd()

The directory to start searching for a package.json from.

create

Type: boolean
Default false

Create the directory synchronously before returning.

throwError

Type: boolean
Default false

Throw an error if a .cache folder can't be found.

Tips

• To test modules using @visulima/find-cache-dir, set the CACHE_DIR environment variable to temporarily override the directory that is resolved.

Related

• find-cache-dir - Find the cache directory.

Supported Node.js Versions

Libraries in this ecosystem make the best effort to track Node.js’ release schedule. Here’s a post on why we think this is important.

Contributing

If you would like to help take a look at the list of issues and check our Contributing guidelines.

Note: please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Credits

• Daniel Bannert
• All Contributors

License

The visulima find-cache-dir is open-sourced software licensed under the MIT