platform-paths/dist/index.d.ts

Retrieve paths to common media folders on each platform.

export interface Options {
    maxAge?: number;
}
declare const getters: {
    tmp: () => Promise<string>;
    home: () => Promise<string>;
    downloads: () => Promise<string>;
    documents: () => Promise<string>;
    pictures: () => Promise<string>;
    music: () => Promise<string>;
    videos: () => Promise<string>;
    desktop: () => Promise<string>;
};
export declare function getPlatformPath(name: string, { maxAge }?: Options): Promise<string>;
export declare const getTmpPath: (options?: Options | undefined) => Promise<string>;
export declare const getHomePath: (options?: Options | undefined) => Promise<string>;
export declare const getDownloadsPath: (options?: Options | undefined) => Promise<string>;
export declare const getDocumentsPath: (options?: Options | undefined) => Promise<string>;
export declare const getPicturesPath: (options?: Options | undefined) => Promise<string>;
export declare const getMusicPath: (options?: Options | undefined) => Promise<string>;
export declare const getVideosPath: (options?: Options | undefined) => Promise<string>;
export declare const getDesktopPath: (options?: Options | undefined) => Promise<string>;
export declare const platformPaths: {
    tmp: (options?: Options | undefined) => Promise<string>;
    home: (options?: Options | undefined) => Promise<string>;
    downloads: (options?: Options | undefined) => Promise<string>;
    documents: (options?: Options | undefined) => Promise<string>;
    pictures: (options?: Options | undefined) => Promise<string>;
    music: (options?: Options | undefined) => Promise<string>;
    videos: (options?: Options | undefined) => Promise<string>;
    desktop: (options?: Options | undefined) => Promise<string>;
};
export declare function clearCache(): void;
export declare function isPlatformPathIdentifier(name: string): name is keyof typeof getters;
export {};