/** * @module * * platformdirs is a library to determine platform-specific system directories. This includes directories where to place cache files, user data, configuration, etc. * * The source code and issue tracker are both hosted on [GitHub](https://github.com/jcbhmr/platformdirs.js). * * Utilities for determining application-specific dirs. * * See https://github.com/jcbhmr/platformdirs.js for details and usage. */ import type { Unix } from "./unix.js"; export type PlatformDirs = Unix; export declare const PlatformDirs: typeof Unix; export type AppDirs = Unix; export declare const AppDirs: typeof Unix; /** * * @param appname See {@link PlatformDirs.appname} * @param appauthor See {@link PlatformDirs.appauthor} * @param version See {@link PlatformDirs.version} * @param roaming See {@link PlatformDirs.roaming} * @param ensureExists See {@link PlatformDirs.ensureExists} * @returns data directory tied to the user */ export declare function userDataDir(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, roaming?: boolean, ensureExists?: boolean): string; /** * * @param appname See {@link PlatformDirs.appname} * @param appauthor See {@link PlatformDirs.appauthor} * @param version See {@link PlatformDirs.version} * @param multipath See {@link PlatformDirs.multipath} * @param ensureExists See {@link PlatformDirs.ensureExists} * @returns data directory shared by users */ export declare function siteDataDir(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, multipath?: boolean, ensureExists?: boolean): string; /** * @param appname See {@link PlatformDirs.appname} * @param appauthor See {@link PlatformDirs.appauthor} * @param version See {@link PlatformDirs.version} * @param roaming See {@link PlatformDirs.roaming} * @param ensureExists See {@link PlatformDirs.ensureExists} * @returns config directory tied to the user */ export declare function userConfigDir(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, roaming?: boolean, ensureExists?: boolean): string; /** * @param appname See {@link PlatformDirs.appname} * @param appauthor See {@link PlatformDirs.appauthor} * @param version See {@link PlatformDirs.version} * @param multipath See {@link PlatformDirs.multipath} * @param ensureExists See {@link PlatformDirs.ensureExists} * @returns config directory shared by users */ export declare function siteConfigDir(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, multipath?: boolean, ensureExists?: boolean): string; /** * @param appname See {@link PlatformDirs.appname} * @param appauthor See {@link PlatformDirs.appauthor} * @param version See {@link PlatformDirs.version} * @param opinion See {@link PlatformDirs.opinion} * @param ensureExists See {@link PlatformDirs.ensureExists} * @returns cache directory tied to the user */ export declare function userCacheDir(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, opinion?: boolean, ensureExists?: boolean): string; /** * @param appname See {@link PlatformDirs.appname} * @param appauthor See {@link PlatformDirs.appauthor} * @param version See {@link PlatformDirs.version} * @param opinion See {@link PlatformDirs.opinion} * @param ensureExists See {@link PlatformDirs.ensureExists} * @returns cache directory tied to the user */ export declare function siteCacheDir(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, opinion?: boolean, ensureExists?: boolean): string; /** * @param appname See {@link PlatformDirs.appname} * @param appauthor See {@link PlatformDirs.appauthor} * @param version See {@link PlatformDirs.version} * @param roaming See {@link PlatformDirs.roaming} * @param ensureExists See {@link PlatformDirs.ensureExists} * @returns state directory tied to the user */ export declare function userStateDir(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, roaming?: boolean, ensureExists?: boolean): string; /** * @param appname See {@link PlatformDirs.appname} * @param appauthor See {@link PlatformDirs.appauthor} * @param version See {@link PlatformDirs.version} * @param opinion See {@link PlatformDirs.opinion} * @param ensureExists See {@link PlatformDirs.ensureExists} * @returns log directory tied to the user */ export declare function userLogDir(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, opinion?: boolean, ensureExists?: boolean): string; /** * @returns documents directory tied to the user */ export declare function userDocumentsDir(): string; /** * @returns downloads directory tied to the user */ export declare function userDownloadsDir(): string; /** * @returns pictures directory tied to the user */ export declare function userPicturesDir(): string; /** * @returns videos directory tied to the user */ export declare function userVideosDir(): string; /** * @returns music directory tied to the user */ export declare function userMusicDir(): string; /** * @returns desktop directory tied to the user */ export declare function userDesktopDir(): string; /** * @param appname See {@link PlatformDirs.appname} * @param appauthor See {@link PlatformDirs.appauthor} * @param version See {@link PlatformDirs.version} * @param opinion See {@link PlatformDirs.opinion} * @param ensureExists See {@link PlatformDirs.ensureExists} * @returns runtime directory tied to the user */ export declare function userRuntimeDir(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, opinion?: boolean, ensureExists?: boolean): string; /** * @param appname See {@link PlatformDirs.appname} * @param appauthor See {@link PlatformDirs.appauthor} * @param version See {@link PlatformDirs.version} * @param opinion See {@link PlatformDirs.opinion} * @param ensureExists See {@link PlatformDirs.ensureExists} * @returns runtime directory shared by users */ export declare function siteRuntimeDir(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, opinion?: boolean, ensureExists?: boolean): string; /** * @param appname See {@link PlatformDirs.appname} * @param appauthor See {@link PlatformDirs.appauthor} * @param version See {@link PlatformDirs.version} * @param roaming See {@link PlatformDirs.roaming} * @param ensureExists See {@link PlatformDirs.ensureExists} * @returns data path tied to the user */ export declare function userDataPath(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, roaming?: boolean, ensureExists?: boolean): string; /** * @param appname See {@link PlatformDirs.appname} * @param appauthor See {@link PlatformDirs.appauthor} * @param version See {@link PlatformDirs.version} * @param multipath See {@link PlatformDirs.multipath} * @param ensureExists See {@link PlatformDirs.ensureExists} * @returns data path shared by users */ export declare function siteDataPath(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, multipath?: boolean, ensureExists?: boolean): string; /** * @param appname See {@link PlatformDirs.appname} * @param appauthor See {@link PlatformDirs.appauthor} * @param version See {@link PlatformDirs.version} * @param roaming See {@link PlatformDirs.roaming} * @param ensureExists See {@link PlatformDirs.ensureExists} * @returns config path tied to the user */ export declare function userConfigPath(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, roaming?: boolean, ensureExists?: boolean): string; /** * @param appname See {@link PlatformDirs.appname} * @param appauthor See {@link PlatformDirs.appauthor} * @param version See {@link PlatformDirs.version} * @param multipath See {@link PlatformDirs.multipath} * @param ensureExists See {@link PlatformDirs.ensureExists} * @returns config path shared by the users */ export declare function siteConfigPath(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, multipath?: boolean, ensureExists?: boolean): string; /** * @param appname See {@link PlatformDirs.appname} * @param appauthor See {@link PlatformDirs.appauthor} * @param version See {@link PlatformDirs.version} * @param opinion See {@link PlatformDirs.opinion} * @param ensureExists See {@link PlatformDirs.ensureExists} * @returns cache path shared by users */ export declare function siteCachePath(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, opinion?: boolean, ensureExists?: boolean): string; /** * @param appname See {@link PlatformDirs.appname} * @param appauthor See {@link PlatformDirs.appauthor} * @param version See {@link PlatformDirs.version} * @param opinion See {@link PlatformDirs.opinion} * @param ensureExists See {@link PlatformDirs.ensureExists} * @returns cache path tied to the user */ export declare function userCachePath(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, opinion?: boolean, ensureExists?: boolean): string; /** * @param appname See {@link PlatformDirs.appname} * @param appauthor See {@link PlatformDirs.appauthor} * @param version See {@link PlatformDirs.version} * @param roaming See {@link PlatformDirs.roaming} * @param ensureExists See {@link PlatformDirs.ensureExists} * @returns state path tied to the user */ export declare function userStatePath(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, roaming?: boolean, ensureExists?: boolean): string; /** * @param appname See {@link PlatformDirs.appname} * @param appauthor See {@link PlatformDirs.appauthor} * @param version See {@link PlatformDirs.version} * @param opinion See {@link PlatformDirs.opinion} * @param ensureExists See {@link PlatformDirs.ensureExists} * @returns log path tied to the user */ export declare function userLogPath(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, opinion?: boolean, ensureExists?: boolean): string; /** @returns documents path tied to the user */ export declare function userDocumentsPath(): string; /** @returns downloads path tied to the user */ export declare function userDownloadsPath(): string; /** @returns pictures path tied to the user */ export declare function userPicturesPath(): string; /** @returns videos path tied to the user */ export declare function userVideosPath(): string; /** @returns music path tied to the user */ export declare function userMusicPath(): string; /** @returns desktop path tied to the user */ export declare function userDesktopPath(): string; /** * @param appname See {@link PlatformDirs.appname} * @param appauthor See {@link PlatformDirs.appauthor} * @param version See {@link PlatformDirs.version} * @param opinion See {@link PlatformDirs.opinion} * @param ensureExists See {@link PlatformDirs.ensureExists} * @returns runtime path tied to the user */ export declare function userRuntimePath(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, opinion?: boolean, ensureExists?: boolean): string; /** * @param appname See {@link PlatformDirs.appname} * @param appauthor See {@link PlatformDirs.appauthor} * @param version See {@link PlatformDirs.version} * @param opinion See {@link PlatformDirs.opinion} * @param ensureExists See {@link PlatformDirs.ensureExists} * @returns runtime path shared by users */ export declare function siteRuntimePath(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, opinion?: boolean, ensureExists?: boolean): string; export { PlatformDirsABC } from "./api.ts"; export { version, versionTuple as versionInfo } from "./version.ts";