kotlin-tauri-apps-api/tauri.apps.api.path

Package-level declarations

Types

sealed external interface BaseDirectory

Functions

external fun appCacheDir(): Promise<String>

Returns the path to the suggested directory for your app's cache files. Resolves to ${cacheDir}/${bundleIdentifier}, where bundleIdentifier is the identifier value configured in tauri.conf.json.

external fun appConfigDir(): Promise<String>

Returns the path to the suggested directory for your app's config files. Resolves to ${configDir}/${bundleIdentifier}, where bundleIdentifier is the identifier value configured in tauri.conf.json.

external fun appDataDir(): Promise<String>

Returns the path to the suggested directory for your app's data files. Resolves to ${dataDir}/${bundleIdentifier}, where bundleIdentifier is the identifier value configured in tauri.conf.json.

appLocalDataDir

external fun appLocalDataDir(): 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 value configured in tauri.conf.json.

external fun appLogDir(): Promise<String>

Returns the path to the suggested directory for your app's log files.

external fun audioDir(): Promise<String>

Returns the path to the user's audio directory.

external fun basename(path: String, ext: String = definedExternally): Promise<String>

Returns the last portion of a path. Trailing directory separators are ignored.

external fun cacheDir(): Promise<String>

Returns the path to the user's cache directory.

external fun configDir(): Promise<String>

Returns the path to the user's config directory.

external fun dataDir(): Promise<String>

Returns the path to the user's data directory.

external fun delimiter(): String

Returns the platform-specific path segment delimiter:

external fun desktopDir(): Promise<String>

Returns the path to the user's desktop directory.

external fun dirname(path: String): Promise<String>

Returns the parent directory of a given path. Trailing directory separators are ignored.

external fun documentDir(): Promise<String>

Returns the path to the user's document directory.

external fun downloadDir(): Promise<String>

Returns the path to the user's download directory.

external fun executableDir(): Promise<String>

Returns the path to the user's executable directory.

external fun extname(path: String): Promise<String>

Returns the extension of the path.

external fun fontDir(): Promise<String>

Returns the path to the user's font directory.

external fun homeDir(): Promise<String>

Returns the path to the user's home directory.

external fun isAbsolute(path: String): Promise<Boolean>

Returns whether the path is absolute or not.

external fun join(vararg paths: String): Promise<String>

Joins all given path segments together using the platform-specific separator as a delimiter, then normalizes the resulting path.

external fun localDataDir(): Promise<String>

Returns the path to the user's local data directory.

external fun normalize(path: String): Promise<String>

Normalizes the given path, resolving '..' and '.' segments and resolve symbolic links.

external fun pictureDir(): Promise<String>

Returns the path to the user's picture directory.

external fun publicDir(): Promise<String>

Returns the path to the user's public directory.

external fun resolve(vararg paths: String): Promise<String>

Resolves a sequence of paths or path segments into an absolute path.

resolveResource

external fun resolveResource(resourcePath: String): Promise<String>

Resolve the path to a resource file.

external fun resourceDir(): Promise<String>

Returns the path to the application's resource directory. To resolve a resource path, see {@linkcode resolveResource}.

external fun runtimeDir(): Promise<String>

Returns the path to the user's runtime directory.

external fun sep(): String

Returns the platform-specific path segment separator:

external fun tempDir(): Promise<String>

Returns a temporary directory.

external fun templateDir(): Promise<String>

Returns the path to the user's template directory.

external fun videoDir(): Promise<String>

Returns the path to the user's video directory.