/** * @module * macOS. */ import { PlatformDirsABC } from "./api.ts"; /** * 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; }