mirror of
https://github.com/mii443/vrclipboard-ime-gui.git
synced 2025-08-22 16:15:32 +00:00
574 lines
16 KiB
TypeScript
574 lines
16 KiB
TypeScript
/**
|
|
* @since 2.0.0
|
|
*/
|
|
declare enum BaseDirectory {
|
|
/**
|
|
* @see {@link audioDir} for more information.
|
|
*/
|
|
Audio = 1,
|
|
/**
|
|
* @see {@link cacheDir} for more information.
|
|
*/
|
|
Cache = 2,
|
|
/**
|
|
* @see {@link configDir} for more information.
|
|
*/
|
|
Config = 3,
|
|
/**
|
|
* @see {@link dataDir} for more information.
|
|
*/
|
|
Data = 4,
|
|
/**
|
|
* @see {@link localDataDir} for more information.
|
|
*/
|
|
LocalData = 5,
|
|
/**
|
|
* @see {@link documentDir} for more information.
|
|
*/
|
|
Document = 6,
|
|
/**
|
|
* @see {@link downloadDir} for more information.
|
|
*/
|
|
Download = 7,
|
|
/**
|
|
* @see {@link pictureDir} for more information.
|
|
*/
|
|
Picture = 8,
|
|
/**
|
|
* @see {@link publicDir} for more information.
|
|
*/
|
|
Public = 9,
|
|
/**
|
|
* @see {@link videoDir} for more information.
|
|
*/
|
|
Video = 10,
|
|
/**
|
|
* @see {@link resourceDir} for more information.
|
|
*/
|
|
Resource = 11,
|
|
/**
|
|
* @see {@link tempDir} for more information.
|
|
*/
|
|
Temp = 12,
|
|
/**
|
|
* @see {@link appConfigDir} for more information.
|
|
*/
|
|
AppConfig = 13,
|
|
/**
|
|
* @see {@link appDataDir} for more information.
|
|
*/
|
|
AppData = 14,
|
|
/**
|
|
* @see {@link appLocalDataDir} for more information.
|
|
*/
|
|
AppLocalData = 15,
|
|
/**
|
|
* @see {@link appCacheDir} for more information.
|
|
*/
|
|
AppCache = 16,
|
|
/**
|
|
* @see {@link appLogDir} for more information.
|
|
*/
|
|
AppLog = 17,
|
|
/**
|
|
* @see {@link desktopDir} for more information.
|
|
*/
|
|
Desktop = 18,
|
|
/**
|
|
* @see {@link executableDir} for more information.
|
|
*/
|
|
Executable = 19,
|
|
/**
|
|
* @see {@link fontDir} for more information.
|
|
*/
|
|
Font = 20,
|
|
/**
|
|
* @see {@link homeDir} for more information.
|
|
*/
|
|
Home = 21,
|
|
/**
|
|
* @see {@link runtimeDir} for more information.
|
|
*/
|
|
Runtime = 22,
|
|
/**
|
|
* @see {@link templateDir} for more information.
|
|
*/
|
|
Template = 23
|
|
}
|
|
/**
|
|
* Returns the path to the suggested directory for your app's config files.
|
|
* Resolves to `${configDir}/${bundleIdentifier}`, where `bundleIdentifier` is the [`identifier`](https://v2.tauri.app/reference/config/#identifier) value configured in `tauri.conf.json`.
|
|
* @example
|
|
* ```typescript
|
|
* import { appConfigDir } from '@tauri-apps/api/path';
|
|
* const appConfigDirPath = await appConfigDir();
|
|
* ```
|
|
*
|
|
* @since 1.2.0
|
|
*/
|
|
declare function appConfigDir(): Promise<string>;
|
|
/**
|
|
* Returns the path to the suggested directory for your app's data files.
|
|
* Resolves to `${dataDir}/${bundleIdentifier}`, where `bundleIdentifier` is the [`identifier`](https://v2.tauri.app/reference/config/#identifier) value configured in `tauri.conf.json`.
|
|
* @example
|
|
* ```typescript
|
|
* import { appDataDir } from '@tauri-apps/api/path';
|
|
* const appDataDirPath = await appDataDir();
|
|
* ```
|
|
*
|
|
* @since 1.2.0
|
|
*/
|
|
declare function appDataDir(): Promise<string>;
|
|
/**
|
|
* Returns the path to the suggested directory for your app's local data files.
|
|
* Resolves to `${localDataDir}/${bundleIdentifier}`, where `bundleIdentifier` is the [`identifier`](https://v2.tauri.app/reference/config/#identifier) value configured in `tauri.conf.json`.
|
|
* @example
|
|
* ```typescript
|
|
* import { appLocalDataDir } from '@tauri-apps/api/path';
|
|
* const appLocalDataDirPath = await appLocalDataDir();
|
|
* ```
|
|
*
|
|
* @since 1.2.0
|
|
*/
|
|
declare function appLocalDataDir(): Promise<string>;
|
|
/**
|
|
* Returns the path to the suggested directory for your app's cache files.
|
|
* Resolves to `${cacheDir}/${bundleIdentifier}`, where `bundleIdentifier` is the [`identifier`](https://v2.tauri.app/reference/config/#identifier) value configured in `tauri.conf.json`.
|
|
* @example
|
|
* ```typescript
|
|
* import { appCacheDir } from '@tauri-apps/api/path';
|
|
* const appCacheDirPath = await appCacheDir();
|
|
* ```
|
|
*
|
|
* @since 1.2.0
|
|
*/
|
|
declare function appCacheDir(): Promise<string>;
|
|
/**
|
|
* Returns the path to the user's audio directory.
|
|
*
|
|
* #### Platform-specific
|
|
*
|
|
* - **Linux:** Resolves to [`xdg-user-dirs`](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' `XDG_MUSIC_DIR`.
|
|
* - **macOS:** Resolves to `$HOME/Music`.
|
|
* - **Windows:** Resolves to `{FOLDERID_Music}`.
|
|
* @example
|
|
* ```typescript
|
|
* import { audioDir } from '@tauri-apps/api/path';
|
|
* const audioDirPath = await audioDir();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function audioDir(): Promise<string>;
|
|
/**
|
|
* Returns the path to the user's cache directory.
|
|
*
|
|
* #### Platform-specific
|
|
*
|
|
* - **Linux:** Resolves to `$XDG_CACHE_HOME` or `$HOME/.cache`.
|
|
* - **macOS:** Resolves to `$HOME/Library/Caches`.
|
|
* - **Windows:** Resolves to `{FOLDERID_LocalAppData}`.
|
|
* @example
|
|
* ```typescript
|
|
* import { cacheDir } from '@tauri-apps/api/path';
|
|
* const cacheDirPath = await cacheDir();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function cacheDir(): Promise<string>;
|
|
/**
|
|
* Returns the path to the user's config directory.
|
|
*
|
|
* #### Platform-specific
|
|
*
|
|
* - **Linux:** Resolves to `$XDG_CONFIG_HOME` or `$HOME/.config`.
|
|
* - **macOS:** Resolves to `$HOME/Library/Application Support`.
|
|
* - **Windows:** Resolves to `{FOLDERID_RoamingAppData}`.
|
|
* @example
|
|
* ```typescript
|
|
* import { configDir } from '@tauri-apps/api/path';
|
|
* const configDirPath = await configDir();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function configDir(): Promise<string>;
|
|
/**
|
|
* Returns the path to the user's data directory.
|
|
*
|
|
* #### Platform-specific
|
|
*
|
|
* - **Linux:** Resolves to `$XDG_DATA_HOME` or `$HOME/.local/share`.
|
|
* - **macOS:** Resolves to `$HOME/Library/Application Support`.
|
|
* - **Windows:** Resolves to `{FOLDERID_RoamingAppData}`.
|
|
* @example
|
|
* ```typescript
|
|
* import { dataDir } from '@tauri-apps/api/path';
|
|
* const dataDirPath = await dataDir();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function dataDir(): Promise<string>;
|
|
/**
|
|
* Returns the path to the user's desktop directory.
|
|
*
|
|
* #### Platform-specific
|
|
*
|
|
* - **Linux:** Resolves to [`xdg-user-dirs`](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' `XDG_DESKTOP_DIR`.
|
|
* - **macOS:** Resolves to `$HOME/Desktop`.
|
|
* - **Windows:** Resolves to `{FOLDERID_Desktop}`.
|
|
* @example
|
|
* ```typescript
|
|
* import { desktopDir } from '@tauri-apps/api/path';
|
|
* const desktopPath = await desktopDir();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function desktopDir(): Promise<string>;
|
|
/**
|
|
* Returns the path to the user's document directory.
|
|
* @example
|
|
* ```typescript
|
|
* import { documentDir } from '@tauri-apps/api/path';
|
|
* const documentDirPath = await documentDir();
|
|
* ```
|
|
*
|
|
* #### Platform-specific
|
|
*
|
|
* - **Linux:** Resolves to [`xdg-user-dirs`](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' `XDG_DOCUMENTS_DIR`.
|
|
* - **macOS:** Resolves to `$HOME/Documents`.
|
|
* - **Windows:** Resolves to `{FOLDERID_Documents}`.
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function documentDir(): Promise<string>;
|
|
/**
|
|
* Returns the path to the user's download directory.
|
|
*
|
|
* #### Platform-specific
|
|
*
|
|
* - **Linux**: Resolves to [`xdg-user-dirs`](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' `XDG_DOWNLOAD_DIR`.
|
|
* - **macOS**: Resolves to `$HOME/Downloads`.
|
|
* - **Windows**: Resolves to `{FOLDERID_Downloads}`.
|
|
* @example
|
|
* ```typescript
|
|
* import { downloadDir } from '@tauri-apps/api/path';
|
|
* const downloadDirPath = await downloadDir();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function downloadDir(): Promise<string>;
|
|
/**
|
|
* Returns the path to the user's executable directory.
|
|
*
|
|
* #### Platform-specific
|
|
*
|
|
* - **Linux:** Resolves to `$XDG_BIN_HOME/../bin` or `$XDG_DATA_HOME/../bin` or `$HOME/.local/bin`.
|
|
* - **macOS:** Not supported.
|
|
* - **Windows:** Not supported.
|
|
* @example
|
|
* ```typescript
|
|
* import { executableDir } from '@tauri-apps/api/path';
|
|
* const executableDirPath = await executableDir();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function executableDir(): Promise<string>;
|
|
/**
|
|
* Returns the path to the user's font directory.
|
|
*
|
|
* #### Platform-specific
|
|
*
|
|
* - **Linux:** Resolves to `$XDG_DATA_HOME/fonts` or `$HOME/.local/share/fonts`.
|
|
* - **macOS:** Resolves to `$HOME/Library/Fonts`.
|
|
* - **Windows:** Not supported.
|
|
* @example
|
|
* ```typescript
|
|
* import { fontDir } from '@tauri-apps/api/path';
|
|
* const fontDirPath = await fontDir();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function fontDir(): Promise<string>;
|
|
/**
|
|
* Returns the path to the user's home directory.
|
|
*
|
|
* #### Platform-specific
|
|
*
|
|
* - **Linux:** Resolves to `$HOME`.
|
|
* - **macOS:** Resolves to `$HOME`.
|
|
* - **Windows:** Resolves to `{FOLDERID_Profile}`.
|
|
* @example
|
|
* ```typescript
|
|
* import { homeDir } from '@tauri-apps/api/path';
|
|
* const homeDirPath = await homeDir();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function homeDir(): Promise<string>;
|
|
/**
|
|
* Returns the path to the user's local data directory.
|
|
*
|
|
* #### Platform-specific
|
|
*
|
|
* - **Linux:** Resolves to `$XDG_DATA_HOME` or `$HOME/.local/share`.
|
|
* - **macOS:** Resolves to `$HOME/Library/Application Support`.
|
|
* - **Windows:** Resolves to `{FOLDERID_LocalAppData}`.
|
|
* @example
|
|
* ```typescript
|
|
* import { localDataDir } from '@tauri-apps/api/path';
|
|
* const localDataDirPath = await localDataDir();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function localDataDir(): Promise<string>;
|
|
/**
|
|
* Returns the path to the user's picture directory.
|
|
*
|
|
* #### Platform-specific
|
|
*
|
|
* - **Linux:** Resolves to [`xdg-user-dirs`](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' `XDG_PICTURES_DIR`.
|
|
* - **macOS:** Resolves to `$HOME/Pictures`.
|
|
* - **Windows:** Resolves to `{FOLDERID_Pictures}`.
|
|
* @example
|
|
* ```typescript
|
|
* import { pictureDir } from '@tauri-apps/api/path';
|
|
* const pictureDirPath = await pictureDir();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function pictureDir(): Promise<string>;
|
|
/**
|
|
* Returns the path to the user's public directory.
|
|
*
|
|
* #### Platform-specific
|
|
*
|
|
* - **Linux:** Resolves to [`xdg-user-dirs`](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' `XDG_PUBLICSHARE_DIR`.
|
|
* - **macOS:** Resolves to `$HOME/Public`.
|
|
* - **Windows:** Resolves to `{FOLDERID_Public}`.
|
|
* @example
|
|
* ```typescript
|
|
* import { publicDir } from '@tauri-apps/api/path';
|
|
* const publicDirPath = await publicDir();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function publicDir(): Promise<string>;
|
|
/**
|
|
* Returns the path to the application's resource directory.
|
|
* To resolve a resource path, see the [[resolveResource | `resolveResource API`]].
|
|
* @example
|
|
* ```typescript
|
|
* import { resourceDir } from '@tauri-apps/api/path';
|
|
* const resourceDirPath = await resourceDir();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function resourceDir(): Promise<string>;
|
|
/**
|
|
* Resolve the path to a resource file.
|
|
* @example
|
|
* ```typescript
|
|
* import { resolveResource } from '@tauri-apps/api/path';
|
|
* const resourcePath = await resolveResource('script.sh');
|
|
* ```
|
|
*
|
|
* @param resourcePath The path to the resource.
|
|
* Must follow the same syntax as defined in `tauri.conf.json > bundle > resources`, i.e. keeping subfolders and parent dir components (`../`).
|
|
* @returns The full path to the resource.
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function resolveResource(resourcePath: string): Promise<string>;
|
|
/**
|
|
* Returns the path to the user's runtime directory.
|
|
*
|
|
* #### Platform-specific
|
|
*
|
|
* - **Linux:** Resolves to `$XDG_RUNTIME_DIR`.
|
|
* - **macOS:** Not supported.
|
|
* - **Windows:** Not supported.
|
|
* @example
|
|
* ```typescript
|
|
* import { runtimeDir } from '@tauri-apps/api/path';
|
|
* const runtimeDirPath = await runtimeDir();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function runtimeDir(): Promise<string>;
|
|
/**
|
|
* Returns the path to the user's template directory.
|
|
*
|
|
* #### Platform-specific
|
|
*
|
|
* - **Linux:** Resolves to [`xdg-user-dirs`](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' `XDG_TEMPLATES_DIR`.
|
|
* - **macOS:** Not supported.
|
|
* - **Windows:** Resolves to `{FOLDERID_Templates}`.
|
|
* @example
|
|
* ```typescript
|
|
* import { templateDir } from '@tauri-apps/api/path';
|
|
* const templateDirPath = await templateDir();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function templateDir(): Promise<string>;
|
|
/**
|
|
* Returns the path to the user's video directory.
|
|
*
|
|
* #### Platform-specific
|
|
*
|
|
* - **Linux:** Resolves to [`xdg-user-dirs`](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' `XDG_VIDEOS_DIR`.
|
|
* - **macOS:** Resolves to `$HOME/Movies`.
|
|
* - **Windows:** Resolves to `{FOLDERID_Videos}`.
|
|
* @example
|
|
* ```typescript
|
|
* import { videoDir } from '@tauri-apps/api/path';
|
|
* const videoDirPath = await videoDir();
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function videoDir(): Promise<string>;
|
|
/**
|
|
* Returns the path to the suggested directory for your app's log files.
|
|
*
|
|
* #### Platform-specific
|
|
*
|
|
* - **Linux:** Resolves to `${configDir}/${bundleIdentifier}/logs`.
|
|
* - **macOS:** Resolves to `${homeDir}/Library/Logs/{bundleIdentifier}`
|
|
* - **Windows:** Resolves to `${configDir}/${bundleIdentifier}/logs`.
|
|
* @example
|
|
* ```typescript
|
|
* import { appLogDir } from '@tauri-apps/api/path';
|
|
* const appLogDirPath = await appLogDir();
|
|
* ```
|
|
*
|
|
* @since 1.2.0
|
|
*/
|
|
declare function appLogDir(): Promise<string>;
|
|
/**
|
|
* Returns a temporary directory.
|
|
* @example
|
|
* ```typescript
|
|
* import { tempDir } from '@tauri-apps/api/path';
|
|
* const temp = await tempDir();
|
|
* ```
|
|
*
|
|
* @since 2.0.0
|
|
*/
|
|
declare function tempDir(): Promise<string>;
|
|
/**
|
|
* Returns the platform-specific path segment separator:
|
|
* - `\` on Windows
|
|
* - `/` on POSIX
|
|
*
|
|
* @since 2.0.0
|
|
*/
|
|
declare function sep(): string;
|
|
/**
|
|
* Returns the platform-specific path segment delimiter:
|
|
* - `;` on Windows
|
|
* - `:` on POSIX
|
|
*
|
|
* @since 2.0.0
|
|
*/
|
|
declare function delimiter(): string;
|
|
/**
|
|
* Resolves a sequence of `paths` or `path` segments into an absolute path.
|
|
* @example
|
|
* ```typescript
|
|
* import { resolve, appDataDir } from '@tauri-apps/api/path';
|
|
* const appDataDirPath = await appDataDir();
|
|
* const path = await resolve(appDataDirPath, '..', 'users', 'tauri', 'avatar.png');
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function resolve(...paths: string[]): Promise<string>;
|
|
/**
|
|
* Normalizes the given `path`, resolving `'..'` and `'.'` segments and resolve symbolic links.
|
|
* @example
|
|
* ```typescript
|
|
* import { normalize, appDataDir } from '@tauri-apps/api/path';
|
|
* const appDataDirPath = await appDataDir();
|
|
* const path = await normalize(`${appDataDirPath}/../users/tauri/avatar.png`);
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function normalize(path: string): Promise<string>;
|
|
/**
|
|
* Joins all given `path` segments together using the platform-specific separator as a delimiter, then normalizes the resulting path.
|
|
* @example
|
|
* ```typescript
|
|
* import { join, appDataDir } from '@tauri-apps/api/path';
|
|
* const appDataDirPath = await appDataDir();
|
|
* const path = await join(appDataDirPath, 'users', 'tauri', 'avatar.png');
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function join(...paths: string[]): Promise<string>;
|
|
/**
|
|
* Returns the directory name of a `path`. Trailing directory separators are ignored.
|
|
* @example
|
|
* ```typescript
|
|
* import { dirname } from '@tauri-apps/api/path';
|
|
* const dir = await dirname('/path/to/somedir/');
|
|
* assert(dir === 'somedir');
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function dirname(path: string): Promise<string>;
|
|
/**
|
|
* Returns the extension of the `path`.
|
|
* @example
|
|
* ```typescript
|
|
* import { extname } from '@tauri-apps/api/path';
|
|
* const ext = await extname('/path/to/file.html');
|
|
* assert(ext === 'html');
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function extname(path: string): Promise<string>;
|
|
/**
|
|
* Returns the last portion of a `path`. Trailing directory separators are ignored.
|
|
* @example
|
|
* ```typescript
|
|
* import { basename } from '@tauri-apps/api/path';
|
|
* const base = await basename('path/to/app.conf');
|
|
* assert(base === 'app.conf');
|
|
* ```
|
|
* @param ext An optional file extension to be removed from the returned path.
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function basename(path: string, ext?: string): Promise<string>;
|
|
/**
|
|
* Returns whether the path is absolute or not.
|
|
* @example
|
|
* ```typescript
|
|
* import { isAbsolute } from '@tauri-apps/api/path';
|
|
* assert(await isAbsolute('/home/tauri'));
|
|
* ```
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
declare function isAbsolute(path: string): Promise<boolean>;
|
|
export { BaseDirectory, appConfigDir, appDataDir, appLocalDataDir, appCacheDir, appLogDir, audioDir, cacheDir, configDir, dataDir, desktopDir, documentDir, downloadDir, executableDir, fontDir, homeDir, localDataDir, pictureDir, publicDir, resourceDir, resolveResource, runtimeDir, templateDir, videoDir, sep, delimiter, resolve, normalize, join, dirname, extname, basename, isAbsolute, tempDir };
|