47 lines
1.9 KiB
Plaintext
47 lines
1.9 KiB
Plaintext
import { Config, CosmiconfigResult, Loaders, LoadersSync } from './types';
|
|
declare type LoaderResult = Config | null;
|
|
export declare type Loader = ((filepath: string, content: string) => Promise<LoaderResult>) | LoaderSync;
|
|
export declare type LoaderSync = (filepath: string, content: string) => LoaderResult;
|
|
export declare type Transform = ((CosmiconfigResult: CosmiconfigResult) => Promise<CosmiconfigResult>) | TransformSync;
|
|
export declare type TransformSync = (CosmiconfigResult: CosmiconfigResult) => CosmiconfigResult;
|
|
interface OptionsBase {
|
|
packageProp?: string | Array<string>;
|
|
searchPlaces?: Array<string>;
|
|
ignoreEmptySearchPlaces?: boolean;
|
|
stopDir?: string;
|
|
cache?: boolean;
|
|
}
|
|
export interface Options extends OptionsBase {
|
|
loaders?: Loaders;
|
|
transform?: Transform;
|
|
}
|
|
export interface OptionsSync extends OptionsBase {
|
|
loaders?: LoadersSync;
|
|
transform?: TransformSync;
|
|
}
|
|
export interface PublicExplorerBase {
|
|
clearLoadCache: () => void;
|
|
clearSearchCache: () => void;
|
|
clearCaches: () => void;
|
|
}
|
|
export interface PublicExplorer extends PublicExplorerBase {
|
|
search: (searchFrom?: string) => Promise<CosmiconfigResult>;
|
|
load: (filepath: string) => Promise<CosmiconfigResult>;
|
|
}
|
|
export interface PublicExplorerSync extends PublicExplorerBase {
|
|
search: (searchFrom?: string) => CosmiconfigResult;
|
|
load: (filepath: string) => CosmiconfigResult;
|
|
}
|
|
export declare const metaSearchPlaces: string[];
|
|
declare const defaultLoaders: Readonly<{
|
|
readonly '.cjs': LoaderSync;
|
|
readonly '.js': LoaderSync;
|
|
readonly '.json': LoaderSync;
|
|
readonly '.yaml': LoaderSync;
|
|
readonly '.yml': LoaderSync;
|
|
readonly noExt: LoaderSync;
|
|
}>;
|
|
declare function cosmiconfig(moduleName: string, options?: Options): PublicExplorer;
|
|
declare function cosmiconfigSync(moduleName: string, options?: OptionsSync): PublicExplorerSync;
|
|
export { cosmiconfig, cosmiconfigSync, defaultLoaders };
|
|
//# sourceMappingURL=index.d.ts.map |