platformdirs 4.3.7 → 4.3.8-rc1

package/dist/index.d.ts

@@ -1,238 +0,0 @@
-/**
- * @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/platformdirs/platformdirs for details and usage.
- */
-import type { Android } from "./android.js";
-import type { MacOS } from "./macos.js";
-import type { Unix } from "./unix.js";
-import type { Windows } from "./windows.js";
-export type PlatformDirs = Windows | MacOS | Unix | Android;
-export declare const PlatformDirs: typeof Windows | typeof MacOS | typeof Unix | typeof Android;
-export declare const AppDirs: typeof Windows | typeof MacOS | typeof Unix | typeof Android;
-/**
- *
- * @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, appauthor?: string | false, version?: string, 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, appauthor?: string | false, version?: string, 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, appauthor?: string | false, version?: string, 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, appauthor?: string | false, version?: string, 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, appauthor?: string | false, version?: string, 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, appauthor?: string | false, version?: string, 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, appauthor?: string | false, version?: string, 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, appauthor?: string | false, version?: string, 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, appauthor?: string | false, version?: string, 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, appauthor?: string | false, version?: string, 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, appauthor?: string | false, version?: string, 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, appauthor?: string | false, version?: string, 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, appauthor?: string | false, version?: string, 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, appauthor?: string | false, version?: string, 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, appauthor?: string | false, version?: string, 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, appauthor?: string | false, version?: string, 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, appauthor?: string | false, version?: string, 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, appauthor?: string | false, version?: string, 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, appauthor?: string | false, version?: string, 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, appauthor?: string | false, version?: string, opinion?: boolean, ensureExists?: boolean): string;
-export { PlatformDirsABC } from "./api.js";
-export { version, versionTuple as versionInfo } from "./version.js";

package/dist/index.js

@@ -1,322 +0,0 @@
-/**
- * @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/platformdirs/platformdirs for details and usage.
- */
-import process from "node:process";
-let Result;
-if (process.platform === "win32") {
-    ({ Windows: Result } = await import("./windows.js"));
-}
-else if (process.platform === "darwin") {
-    ({ MacOS: Result } = await import("./macos.js"));
-}
-else {
-    ({ Unix: Result } = await import("./unix.js"));
-}
-async function setPlatformDirClass() {
-    if (process.env.ANDROID_DATA === "/data" &&
-        process.env.ANDROID_ROOT === "/system") {
-        if (process.env.SHELL || process.env.PREFIX) {
-            return Result;
-        }
-        const { _androidFolder } = await import("./android.js");
-        if (_androidFolder() != null) {
-            const { Android } = await import("./android.js");
-            return Android;
-        }
-    }
-    return Result;
-}
-export const PlatformDirs = (await setPlatformDirClass());
-export const AppDirs = PlatformDirs;
-/**
- *
- * @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 function userDataDir(appname, appauthor, version, roaming = false, ensureExists = false) {
-    return new PlatformDirs(appname, appauthor, version, roaming, undefined, undefined, ensureExists).userDataDir;
-}
-/**
- *
- * @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 function siteDataDir(appname, appauthor, version, multipath = false, ensureExists = false) {
-    return new PlatformDirs(appname, appauthor, version, undefined, multipath, undefined, ensureExists).siteDataDir;
-}
-/**
- * @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 function userConfigDir(appname, appauthor, version, roaming = false, ensureExists = false) {
-    return new PlatformDirs(appname, appauthor, version, roaming, undefined, undefined, ensureExists).userConfigDir;
-}
-/**
- * @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 function siteConfigDir(appname, appauthor, version, multipath = false, ensureExists = false) {
-    return new PlatformDirs(appname, appauthor, version, undefined, multipath, undefined, ensureExists).siteConfigDir;
-}
-/**
- * @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 function userCacheDir(appname, appauthor, version, opinion = true, ensureExists = false) {
-    return new PlatformDirs(appname, appauthor, version, undefined, undefined, opinion, ensureExists).userCacheDir;
-}
-/**
- * @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 function siteCacheDir(appname, appauthor, version, opinion = true, ensureExists = false) {
-    return new PlatformDirs(appname, appauthor, version, undefined, undefined, opinion, ensureExists).siteCacheDir;
-}
-/**
- * @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 function userStateDir(appname, appauthor, version, roaming = false, ensureExists = false) {
-    return new PlatformDirs(appname, appauthor, version, roaming, undefined, undefined, ensureExists).userStateDir;
-}
-/**
- * @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 function userLogDir(appname, appauthor, version, opinion = true, ensureExists = false) {
-    return new PlatformDirs(appname, appauthor, version, undefined, undefined, opinion, ensureExists).userLogDir;
-}
-/**
- * @returns documents directory tied to the user
- */
-export function userDocumentsDir() {
-    return new PlatformDirs().userDocumentsDir;
-}
-/**
- * @returns downloads directory tied to the user
- */
-export function userDownloadsDir() {
-    return new PlatformDirs().userDownloadsDir;
-}
-/**
- * @returns pictures directory tied to the user
- */
-export function userPicturesDir() {
-    return new PlatformDirs().userPicturesDir;
-}
-/**
- * @returns videos directory tied to the user
- */
-export function userVideosDir() {
-    return new PlatformDirs().userVideosDir;
-}
-/**
- * @returns music directory tied to the user
- */
-export function userMusicDir() {
-    return new PlatformDirs().userMusicDir;
-}
-/**
- * @returns desktop directory tied to the user
- */
-export function userDesktopDir() {
-    return new PlatformDirs().userDesktopDir;
-}
-/**
- * @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 function userRuntimeDir(appname, appauthor, version, opinion = true, ensureExists = false) {
-    return new PlatformDirs(appname, appauthor, version, undefined, undefined, opinion, ensureExists).userRuntimeDir;
-}
-/**
- * @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 function siteRuntimeDir(appname, appauthor, version, opinion = true, ensureExists = false) {
-    return new PlatformDirs(appname, appauthor, version, undefined, undefined, opinion, ensureExists).siteRuntimeDir;
-}
-/**
- * @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 function userDataPath(appname, appauthor, version, roaming = false, ensureExists = false) {
-    return new PlatformDirs(appname, appauthor, version, roaming, undefined, undefined, ensureExists).userDataPath;
-}
-/**
- * @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 function siteDataPath(appname, appauthor, version, multipath = false, ensureExists = false) {
-    return new PlatformDirs(appname, appauthor, version, undefined, multipath, undefined, ensureExists).siteDataPath;
-}
-/**
- * @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 function userConfigPath(appname, appauthor, version, roaming = false, ensureExists = false) {
-    return new PlatformDirs(appname, appauthor, version, roaming, undefined, undefined, ensureExists).userConfigPath;
-}
-/**
- * @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 function siteConfigPath(appname, appauthor, version, multipath = false, ensureExists = false) {
-    return new PlatformDirs(appname, appauthor, version, undefined, multipath, undefined, ensureExists).siteConfigPath;
-}
-/**
- * @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 function siteCachePath(appname, appauthor, version, opinion = true, ensureExists = false) {
-    return new PlatformDirs(appname, appauthor, version, undefined, undefined, opinion, ensureExists).siteCachePath;
-}
-/**
- * @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 function userCachePath(appname, appauthor, version, opinion = true, ensureExists = false) {
-    return new PlatformDirs(appname, appauthor, version, undefined, undefined, opinion, ensureExists).userCachePath;
-}
-/**
- * @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 function userStatePath(appname, appauthor, version, roaming = false, ensureExists = false) {
-    return new PlatformDirs(appname, appauthor, version, roaming, undefined, undefined, ensureExists).userStatePath;
-}
-/**
- * @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 function userLogPath(appname, appauthor, version, opinion = true, ensureExists = false) {
-    return new PlatformDirs(appname, appauthor, version, undefined, undefined, opinion, ensureExists).userLogPath;
-}
-/** @returns documents path tied to the user */
-export function userDocumentsPath() {
-    return new PlatformDirs().userDocumentsPath;
-}
-/** @returns downloads path tied to the user */
-export function userDownloadsPath() {
-    return new PlatformDirs().userDownloadsPath;
-}
-/** @returns pictures path tied to the user */
-export function userPicturesPath() {
-    return new PlatformDirs().userPicturesPath;
-}
-/** @returns videos path tied to the user */
-export function userVideosPath() {
-    return new PlatformDirs().userVideosPath;
-}
-/** @returns music path tied to the user */
-export function userMusicPath() {
-    return new PlatformDirs().userMusicPath;
-}
-/** @returns desktop path tied to the user */
-export function userDesktopPath() {
-    return new PlatformDirs().userDesktopPath;
-}
-/**
- * @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 function userRuntimePath(appname, appauthor, version, opinion = true, ensureExists = false) {
-    return new PlatformDirs(appname, appauthor, version, undefined, undefined, opinion, ensureExists).userRuntimePath;
-}
-/**
- * @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 function siteRuntimePath(appname, appauthor, version, opinion = true, ensureExists = false) {
-    return new PlatformDirs(appname, appauthor, version, undefined, undefined, opinion, ensureExists).siteRuntimePath;
-}
-export { PlatformDirsABC } from "./api.js";
-export { version, versionTuple as versionInfo } from "./version.js";

package/dist/macos.d.ts

@@ -1,97 +0,0 @@
-/**
- * @module
- * macOS.
- */
-import { PlatformDirsABC } from "./api.js";
-/**
- * Platform directories for the macOS operating system.
- *
- * Follows the guidance from [Apple documentation](https://developer.apple.com/library/archive/documentation/FileManagement/Conceptual/FileSystemProgrammingGuide/MacOSXDirectories/MacOSXDirectories.html). Makes use of the {@link PlatformDirsABC.appname}, {@link PlatformDirsABC.version}, {@link PlatformDirsABC.ensureExists}.
- */
-export declare class MacOS extends PlatformDirsABC {
-    /**
-     * @return data directory tied to the user, e.g. `~/Library/Application Support/$appname/$version`
-     */
-    get userDataDir(): string;
-    /**
-     * @return data directory shared by users, e.g. `/Library/Application
-     * Support/$appname/$version`. If we're using a Node.js, Deno, or Bun binary
-     * managed by [Homebrew](https://brew.sh), the directory will be under the
-     * Homebrew prefix, e.g. `/opt/homebrew/share/$appname/$version`. If
-     * {@link PlatformDirsABC.multipath} is enabled, and we're in Homebrew, the
-     * response is a multi-path string separated by ":", e.g.
-     * `/opt/homebrew/share/$appname/$version:/Library/Application
-     * Support/$appname/$version`.
-     */
-    get siteDataDir(): string;
-    /**
-     * @return data path shared by users. Only return the first item, even if
-     * `multipath` is enabled is set to `true`.
-     */
-    get siteDataPath(): string;
-    /**
-     * @return config directory tied to the user, same as `userDataDir`
-     */
-    get userConfigDir(): string;
-    /**
-     * @return config directory shared by users, same as `siteDataDir`
-     */
-    get siteConfigDir(): string;
-    /**
-     * @return cache directory tied to the user, e.g. `~/Library/Caches/$appname/$version`
-     */
-    get userCacheDir(): string;
-    /**
-     * @return cache directory shared by users, e.g. `/Library/Caches/$appname/$version`.
-     * If we're using a Node.js, Deno, or Bun binary managed by [Homebrew](https://brew.sh),
-     * the directory will be under the Homebrew prefix, e.g. `/opt/homebrew/var/cache/$appname/$version`.
-     * If {@link PlatformDirsABC.multipath} is enabled, and we're in Homebrew, the response is a multi-path string separated by ":", e.g.
-     * `/opt/homebrew/var/cache/$appname/$version:/Library/Caches/$appname/$version`.
-     */
-    get siteCacheDir(): string;
-    /**
-     * @return cache path shared by users. Only return the first item, even if
-     * `multipath` is enabled is set to `true`.
-     */
-    get siteCachePath(): string;
-    /**
-     * @return state directory tied to the user, e.g. `~/Library/Application Support/$appname/$version`
-     */
-    get userStateDir(): string;
-    /**
-     * @return log directory tied to the user, e.g. `~/Library/Logs/$appname/$version`
-     */
-    get userLogDir(): string;
-    /**
-     * @return documents directory tied to the user, e.g. `~/Documents`
-     */
-    get userDocumentsDir(): string;
-    /**
-     * @return downloads directory tied to the user, e.g. `~/Downloads`
-     */
-    get userDownloadsDir(): string;
-    /**
-     * @return pictures directory tied to the user, e.g. `~/Pictures`
-     */
-    get userPicturesDir(): string;
-    /**
-     * @return videos directory tied to the user, e.g. `~/Movies`
-     */
-    get userVideosDir(): string;
-    /**
-     * @return music directory tied to the user, e.g. `~/Music`
-     */
-    get userMusicDir(): string;
-    /**
-     * @return desktop directory tied to the user, e.g. `~/Desktop`
-     */
-    get userDesktopDir(): string;
-    /**
-     * @return runtime directory tied to the user, e.g. `~/Library/Caches/TemporaryItems`
-     */
-    get userRuntimeDir(): string;
-    /**
-     * @return runtime directory shared by users, same as `userRuntimeDir`
-     */
-    get siteRuntimeDir(): string;
-}