@types/find-cache-dir
Advanced tools
TypeScript definitions for find-cache-dir
Package description
The @types/find-cache-dir package provides TypeScript type definitions for the find-cache-dir library, which is a utility that helps you find a cache directory based on the npm package name. This is particularly useful in development environments where caching of output can significantly speed up build processes. The type definitions ensure that TypeScript users can integrate find-cache-dir into their projects with type safety.
Type Definitions for Cache Directory Finding
This code demonstrates how to use find-cache-dir with TypeScript to find or create a cache directory specific to an application named 'my-app'. The @types/find-cache-dir package provides the necessary type definitions to ensure type safety and autocompletion in TypeScript environments.
import findCacheDir from 'find-cache-dir';
const cacheDir = findCacheDir({ name: 'my-app' });
console.log(cacheDir);This is the actual JavaScript implementation of the functionality to find a cache directory. It provides the core functionality which @types/find-cache-dir types are based on. Unlike @types/find-cache-dir, which only provides type definitions, find-cache-dir contains the executable code necessary for the actual computation of cache directory paths.
Cache-conf is a package for managing cache configurations and data. It provides more extensive features for handling cache data, such as reading, writing, and deleting cache entries. This package is more comprehensive in managing cache data compared to find-cache-dir, which primarily focuses on locating a cache directory.
Make-dir is a utility that helps in creating directories with support for deep nested paths. It is similar to find-cache-dir in that it helps manage directory structures in your project, but it does not specifically target cache directories or integrate with npm package names for directory determination.
Readme
npm install --save @types/find-cache-dir
This package contains type definitions for find-cache-dir (https://github.com/avajs/find-cache-dir#readme).
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/find-cache-dir.
// Type definitions for find-cache-dir 3.2
// Project: https://github.com/avajs/find-cache-dir#readme
// Definitions by: BendingBender <https://github.com/BendingBender>
// Piotr Błażejewicz <https://github.com/peterblazejewicz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
export = findCacheDir;
/**
* Finds the cache directory using the supplied options.
* The algorithm tries to find a `package.json` file, searching every parent directory of the `cwd` specified
* (or implied from other options). It returns a `string` containing the absolute path to the cache directory,
* or `undefined` if `package.json` was never found or if the `node_modules` directory is unwritable.
*/
declare function findCacheDir(options: findCacheDir.OptionsWithThunk): ((...pathParts: string[]) => string) | undefined;
declare function findCacheDir(options: findCacheDir.Options): string | undefined;
declare namespace findCacheDir {
interface Options {
/**
* Should be the same as your project name in `package.json`.
*/
name: string;
/**
* An array of files that will be searched for a common parent directory.
* This common parent directory will be used in lieu of the `cwd` option below.
*/
files?: string | string[] | undefined;
/**
* Directory to start searching for a `package.json` from.
*/
cwd?: string | undefined;
/**
* If `true`, the directory will be created synchronously before returning.
* @default false
*/
create?: boolean | undefined;
/**
* If `true`, this modifies the return type to be a function that is a thunk for `path.join(theFoundCacheDirectory)`.
* @default false
*/
thunk?: boolean | undefined;
}
interface OptionsWithThunk extends Options {
/**
* If `true`, this modifies the return type to be a function that is a thunk for `path.join(theFoundCacheDirectory)`.
* @default false
*/
thunk: true;
}
}
These definitions were written by BendingBender, and Piotr Błażejewicz.
FAQs
Stub TypeScript definitions entry for find-cache-dir, which provides its own types definitions
The npm package @types/find-cache-dir receives a total of 2,906,185 weekly downloads. As such, @types/find-cache-dir popularity was classified as popular.
We found that @types/find-cache-dir demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Researchers recently demonstrated that the npm Registry is vulnerable to cache poisoning combined with DoS, posing significant risks for package availability.
Security News
The June TC39 meeting wrapped up this week with eight proposals moving on to the next stage. Here's a quick roundup of the features that the committee approved to advance.
Security News
Cyber extortion in the US and Canada hit record levels in 2023, with ransomware attacks surging and median ransom demands skyrocketing, though fewer companies are choosing to pay ransoms.