5.0.0 • Published 9 months ago
@types/find-cache-dir v5.0.0
Installation
npm install --save @types/find-cache-dir
Summary
This package contains type definitions for find-cache-dir (https://github.com/avajs/find-cache-dir#readme).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/find-cache-dir/v2.
index.d.ts
// Type definitions for find-cache-dir 2.0
// Project: https://github.com/avajs/find-cache-dir#readme
// Definitions by: BendingBender <https://github.com/BendingBender>
// 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).
* @param options
* @returns A string containing the absolute path to the cache directory, or null if package.json was never found.
*/
declare function findCacheDir(
options: findCacheDir.OptionsWithThunk
): ((...pathParts: string[]) => string) | null;
declare function findCacheDir(options: findCacheDir.Options): string | null;
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;
}
}
Additional Details
- Last updated: Tue, 06 Jul 2021 20:32:58 GMT
- Dependencies: none
- Global values: none
Credits
These definitions were written by BendingBender.