platformdirs 4.3.6-rc1

package/dist/index.js

@@ -0,0 +1,322 @@
+/**
+ * @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

@@ -0,0 +1,97 @@
+/**
+ * @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;
+}

package/dist/macos.js

@@ -0,0 +1,155 @@
+/**
+ * @module
+ * macOS.
+ */
+import * as os from "node:os";
+import * as path from "node:path";
+import process from "node:process";
+import { PlatformDirsABC } from "./api.js";
+function expanduser(path2) {
+    return path2.replace(/^~\//, `${os.homedir()}/`);
+}
+/**
+ * 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 class MacOS extends PlatformDirsABC {
+    /**
+     * @return data directory tied to the user, e.g. `~/Library/Application Support/$appname/$version`
+     */
+    get userDataDir() {
+        return this._appendAppNameAndVersion(expanduser("~/Library/Application Support"));
+    }
+    /**
+     * @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() {
+        const isHomebrew = process.execPath.startsWith("/opt/homebrew");
+        const pathList = isHomebrew
+            ? [this._appendAppNameAndVersion("/opt/homebrew/share")]
+            : [];
+        pathList.push(this._appendAppNameAndVersion("/Library/Application Support"));
+        if (this.multipath) {
+            return pathList.join(path.delimiter);
+        }
+        return pathList[0];
+    }
+    /**
+     * @return data path shared by users. Only return the first item, even if
+     * `multipath` is enabled is set to `true`.
+     */
+    get siteDataPath() {
+        return this._firstItemAsPathIfMultipath(this.siteDataDir);
+    }
+    /**
+     * @return config directory tied to the user, same as `userDataDir`
+     */
+    get userConfigDir() {
+        return this.userDataDir;
+    }
+    /**
+     * @return config directory shared by users, same as `siteDataDir`
+     */
+    get siteConfigDir() {
+        return this.siteDataDir;
+    }
+    /**
+     * @return cache directory tied to the user, e.g. `~/Library/Caches/$appname/$version`
+     */
+    get userCacheDir() {
+        return this._appendAppNameAndVersion(expanduser("~/Library/Caches"));
+    }
+    /**
+     * @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() {
+        const isHomebrew = process.execPath.startsWith("/opt/homebrew");
+        const pathList = isHomebrew
+            ? [this._appendAppNameAndVersion("/opt/homebrew/var/cache")]
+            : [];
+        pathList.push(this._appendAppNameAndVersion("/Library/Caches"));
+        if (this.multipath) {
+            return pathList.join(path.delimiter);
+        }
+        return pathList[0];
+    }
+    /**
+     * @return cache path shared by users. Only return the first item, even if
+     * `multipath` is enabled is set to `true`.
+     */
+    get siteCachePath() {
+        return this._firstItemAsPathIfMultipath(this.siteCacheDir);
+    }
+    /**
+     * @return state directory tied to the user, e.g. `~/Library/Application Support/$appname/$version`
+     */
+    get userStateDir() {
+        return this.userDataDir;
+    }
+    /**
+     * @return log directory tied to the user, e.g. `~/Library/Logs/$appname/$version`
+     */
+    get userLogDir() {
+        return this._appendAppNameAndVersion(expanduser("~/Library/Logs"));
+    }
+    /**
+     * @return documents directory tied to the user, e.g. `~/Documents`
+     */
+    get userDocumentsDir() {
+        return expanduser("~/Documents");
+    }
+    /**
+     * @return downloads directory tied to the user, e.g. `~/Downloads`
+     */
+    get userDownloadsDir() {
+        return expanduser("~/Downloads");
+    }
+    /**
+     * @return pictures directory tied to the user, e.g. `~/Pictures`
+     */
+    get userPicturesDir() {
+        return expanduser("~/Pictures");
+    }
+    /**
+     * @return videos directory tied to the user, e.g. `~/Movies`
+     */
+    get userVideosDir() {
+        return expanduser("~/Movies");
+    }
+    /**
+     * @return music directory tied to the user, e.g. `~/Music`
+     */
+    get userMusicDir() {
+        return expanduser("~/Music");
+    }
+    /**
+     * @return desktop directory tied to the user, e.g. `~/Desktop`
+     */
+    get userDesktopDir() {
+        return expanduser("~/Desktop");
+    }
+    /**
+     * @return runtime directory tied to the user, e.g. `~/Library/Caches/TemporaryItems`
+     */
+    get userRuntimeDir() {
+        return this._appendAppNameAndVersion(expanduser("~/Library/Caches/TemporaryItems"));
+    }
+    /**
+     * @return runtime directory shared by users, same as `userRuntimeDir`
+     */
+    get siteRuntimeDir() {
+        return this.userRuntimeDir;
+    }
+}

package/dist/main.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/main.js

@@ -0,0 +1,41 @@
+import { PlatformDirs, version } from "./index.js";
+const props = {
+    user_data_dir: "userDataDir",
+    user_config_dir: "userConfigDir",
+    user_cache_dir: "userCacheDir",
+    user_state_dir: "userStateDir",
+    user_log_dir: "userLogDir",
+    user_documents_dir: "userDocumentsDir",
+    user_downloads_dir: "userDownloadsDir",
+    user_pictures_dir: "userPicturesDir",
+    user_videos_dir: "userVideosDir",
+    user_music_dir: "userMusicDir",
+    user_runtime_dir: "userRuntimeDir",
+    site_data_dir: "siteDataDir",
+    site_config_dir: "siteConfigDir",
+    site_cache_dir: "siteCacheDir",
+    site_runtime_dir: "siteRuntimeDir",
+};
+const appName = "MyApp";
+const appAuthor = "MyCompany";
+console.log(`-- platformdirs ${version} --`);
+console.log("-- app dirs (with optional 'version')");
+let dirs = new PlatformDirs(appName, appAuthor, "1.0");
+for (const [label, key] of Object.entries(props)) {
+    console.log(`${label}: ${dirs[key]}`);
+}
+console.log("\n-- app dirs (without optional 'version')");
+dirs = new PlatformDirs(appName, appAuthor);
+for (const [label, key] of Object.entries(props)) {
+    console.log(`${label}: ${dirs[key]}`);
+}
+console.log("\n-- app dirs (without optional 'appauthor')");
+dirs = new PlatformDirs(appName);
+for (const [label, key] of Object.entries(props)) {
+    console.log(`${label}: ${dirs[key]}`);
+}
+console.log("\n-- app dirs (with disabled 'appauthor')");
+dirs = new PlatformDirs(appName, false);
+for (const [label, key] of Object.entries(props)) {
+    console.log(`${label}: ${dirs[key]}`);
+}