Interface IPath

interface IPath {
    BaseDirectory: typeof BaseDirectory;
    appCacheDir: (() => Promise<string>);
    appConfigDir: (() => Promise<string>);
    appDataDir: (() => Promise<string>);
    appLocalDataDir: (() => Promise<string>);
    appLogDir: (() => Promise<string>);
    audioDir: (() => Promise<string>);
    basename: ((path: string, ext?: string) => Promise<string>);
    cacheDir: (() => Promise<string>);
    configDir: (() => Promise<string>);
    dataDir: (() => Promise<string>);
    delimiter: (() => Promise<string>);
    desktopDir: (() => Promise<string>);
    dirname: ((path: string) => Promise<string>);
    documentDir: (() => Promise<string>);
    downloadDir: (() => Promise<string>);
    executableDir: (() => Promise<string>);
    extname: ((path: string) => Promise<string>);
    fontDir: (() => Promise<string>);
    homeDir: (() => Promise<string>);
    isAbsolute: ((path: string) => Promise<boolean>);
    join: ((...paths: string[]) => Promise<string>);
    localDataDir: (() => Promise<string>);
    normalize: ((path: string) => Promise<string>);
    pictureDir: (() => Promise<string>);
    publicDir: (() => Promise<string>);
    resolve: ((...paths: string[]) => Promise<string>);
    resolveResource: ((resourcePath: string) => Promise<string>);
    resourceDir: (() => Promise<string>);
    runtimeDir: (() => Promise<string>);
    sep: (() => Promise<string>);
    tempDir: (() => Promise<string>);
    templateDir: (() => Promise<string>);
    videoDir: (() => Promise<string>);
}

Properties

BaseDirectory

BaseDirectory: typeof BaseDirectory

appCacheDir

appCacheDir: (() => Promise<string>)

Type declaration

- (): Promise<string>
- Returns the path to the suggested directory for your app's cache files. Resolves to ${cacheDir}/${bundleIdentifier}, where bundleIdentifier is the value tauri.bundle.identifier is configured in tauri.conf.json.
  
  Returns Promise<string>
  Example
```
import { appCacheDir } from '@tauri-apps/api/path';
const appCacheDirPath = await appCacheDir();
```
  Since
  1.2.0

appConfigDir

appConfigDir: (() => Promise<string>)

Type declaration

- (): Promise<string>
- Returns the path to the suggested directory for your app's config files. Resolves to ${configDir}/${bundleIdentifier}, where bundleIdentifier is the value tauri.bundle.identifier is configured in tauri.conf.json.
  
  Returns Promise<string>
  Example
```
import { appConfigDir } from '@tauri-apps/api/path';
const appConfigDirPath = await appConfigDir();
```
  Since
  1.2.0

appDataDir

appDataDir: (() => Promise<string>)

Type declaration

- (): Promise<string>
- Returns the path to the suggested directory for your app's data files. Resolves to ${dataDir}/${bundleIdentifier}, where bundleIdentifier is the value tauri.bundle.identifier is configured in tauri.conf.json.
  
  Returns Promise<string>
  Example
```
import { appDataDir } from '@tauri-apps/api/path';
const appDataDirPath = await appDataDir();
```
  Since
  1.2.0

appLocalDataDir

appLocalDataDir: (() => Promise<string>)

Type declaration

- (): Promise<string>
- Returns the path to the suggested directory for your app's local data files. Resolves to ${localDataDir}/${bundleIdentifier}, where bundleIdentifier is the value tauri.bundle.identifier is configured in tauri.conf.json.
  
  Returns Promise<string>
  Example
```
import { appLocalDataDir } from '@tauri-apps/api/path';
const appLocalDataDirPath = await appLocalDataDir();
```
  Since
  1.2.0

appLogDir

appLogDir: (() => Promise<string>)

Type declaration

- (): 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.
  Returns Promise<string>
  Example
```
import { appLogDir } from '@tauri-apps/api/path';
const appLogDirPath = await appLogDir();
```
  Since
  1.2.0

audioDir

audioDir: (() => Promise<string>)

Type declaration

- (): Promise<string>
- Returns the path to the user's audio directory.
  
  Platform-specific
  - Linux: Resolves to xdg-user-dirs' XDG_MUSIC_DIR.
  - macOS: Resolves to $HOME/Music.
  - Windows: Resolves to {FOLDERID_Music}.
  Returns Promise<string>
  Example
```
import { audioDir } from '@tauri-apps/api/path';
const audioDirPath = await audioDir();
```
  Since
  1.0.0

basename

basename: ((path: string, ext?: string) => Promise<string>)

Type declaration

- (path, ext?): Promise<string>
- Returns the last portion of a path. Trailing directory separators are ignored.
  Parameters
  - path: string
  - Optionalext: string
    An optional file extension to be removed from the returned path.
  Returns Promise<string>
  Example
```
import { basename } from '@tauri-apps/api/path';
const base = await basename('path/to/app.conf');
assert(base === 'app.conf');
```
  Since
  1.0.0

cacheDir

cacheDir: (() => Promise<string>)

Type declaration

- (): 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}.
  Returns Promise<string>
  Example
```
import { cacheDir } from '@tauri-apps/api/path';
const cacheDirPath = await cacheDir();
```
  Since
  1.0.0

configDir

configDir: (() => Promise<string>)

Type declaration

- (): 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}.
  Returns Promise<string>
  Example
```
import { configDir } from '@tauri-apps/api/path';
const configDirPath = await configDir();
```
  Since
  1.0.0

dataDir

dataDir: (() => Promise<string>)

Type declaration

- (): 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}.
  Returns Promise<string>
  Example
```
import { dataDir } from '@tauri-apps/api/path';
const dataDirPath = await dataDir();
```
  Since
  1.0.0

delimiter

delimiter: (() => Promise<string>)

desktopDir

desktopDir: (() => Promise<string>)

Type declaration

- (): Promise<string>
- Returns the path to the user's desktop directory.
  
  Platform-specific
  - Linux: Resolves to xdg-user-dirs' XDG_DESKTOP_DIR.
  - macOS: Resolves to $HOME/Desktop.
  - Windows: Resolves to {FOLDERID_Desktop}.
  Returns Promise<string>
  Example
```
import { desktopDir } from '@tauri-apps/api/path';
const desktopPath = await desktopDir();
```
  Since
  1.0.0

dirname

dirname: ((path: string) => Promise<string>)

Type declaration

- (path): Promise<string>
- Returns the directory name of a path. Trailing directory separators are ignored.
  Parameters
  - path: string
  Returns Promise<string>
  Example
```
import { dirname } from '@tauri-apps/api/path';
const dir = await dirname('/path/to/somedir/');
assert(dir === 'somedir');
```
  Since
  1.0.0

documentDir

documentDir: (() => Promise<string>)

Type declaration

- (): Promise<string>
- Returns the path to the user's document directory.
  
  Returns Promise<string>
  Example
```
import { documentDir } from '@tauri-apps/api/path';
const documentDirPath = await documentDir();
```
  Platform-specific
  - Linux: Resolves to xdg-user-dirs' XDG_DOCUMENTS_DIR.
  - macOS: Resolves to $HOME/Documents.
  - Windows: Resolves to {FOLDERID_Documents}.
  Since
  1.0.0

downloadDir

downloadDir: (() => Promise<string>)

Type declaration

- (): Promise<string>
- Returns the path to the user's download directory.
  
  Platform-specific
  - Linux: Resolves to xdg-user-dirs' XDG_DOWNLOAD_DIR.
  - macOS: Resolves to $HOME/Downloads.
  - Windows: Resolves to {FOLDERID_Downloads}.
  Returns Promise<string>
  Example
```
import { downloadDir } from '@tauri-apps/api/path';
const downloadDirPath = await downloadDir();
```
  Since
  1.0.0

executableDir

executableDir: (() => Promise<string>)

Type declaration

- (): 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.
  Returns Promise<string>
  Example
```
import { executableDir } from '@tauri-apps/api/path';
const executableDirPath = await executableDir();
```
  Since
  1.0.0

extname

extname: ((path: string) => Promise<string>)

Type declaration

(path): Promise<string>

Returns the extension of the path.

Parameters

path: string

Returns Promise<string>

Example

import { extname } from '@tauri-apps/api/path';
const ext = await extname('/path/to/file.html');
assert(ext === 'html');

Since

1.0.0

fontDir

fontDir: (() => Promise<string>)

Type declaration

- (): 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.
  Returns Promise<string>
  Example
```
import { fontDir } from '@tauri-apps/api/path';
const fontDirPath = await fontDir();
```
  Since
  1.0.0

homeDir

homeDir: (() => Promise<string>)

Type declaration

- (): 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}.
  Returns Promise<string>
  Example
```
import { homeDir } from '@tauri-apps/api/path';
const homeDirPath = await homeDir();
```
  Since
  1.0.0

isAbsolute

isAbsolute: ((path: string) => Promise<boolean>)

Type declaration

- (path): Promise<boolean>
- Returns whether the path is absolute or not.
  Parameters
  - path: string
  Returns Promise<boolean>
  Example
```
import { isAbsolute } from '@tauri-apps/api/path';
assert(await isAbsolute('/home/tauri'));
```
  Since
  1.0.0

join

join: ((...paths: string[]) => Promise<string>)

Type declaration

- (...paths): Promise<string>
- Joins all given path segments together using the platform-specific separator as a delimiter, then normalizes the resulting path.
  Parameters
  - Rest...paths: string[]
  Returns Promise<string>
  Example
```
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

localDataDir

localDataDir: (() => Promise<string>)

Type declaration

- (): 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}.
  Returns Promise<string>
  Example
```
import { localDataDir } from '@tauri-apps/api/path';
const localDataDirPath = await localDataDir();
```
  Since
  1.0.0

normalize

normalize: ((path: string) => Promise<string>)

Type declaration

(path): Promise<string>

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

Parameters

path: string

Returns Promise<string>

Example

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

pictureDir

pictureDir: (() => Promise<string>)

Type declaration

- (): Promise<string>
- Returns the path to the user's picture directory.
  
  Platform-specific
  - Linux: Resolves to xdg-user-dirs' XDG_PICTURES_DIR.
  - macOS: Resolves to $HOME/Pictures.
  - Windows: Resolves to {FOLDERID_Pictures}.
  Returns Promise<string>
  Example
```
import { pictureDir } from '@tauri-apps/api/path';
const pictureDirPath = await pictureDir();
```
  Since
  1.0.0

publicDir

publicDir: (() => Promise<string>)

Type declaration

- (): Promise<string>
- Returns the path to the user's public directory.
  
  Platform-specific
  - Linux: Resolves to xdg-user-dirs' XDG_PUBLICSHARE_DIR.
  - macOS: Resolves to $HOME/Public.
  - Windows: Resolves to {FOLDERID_Public}.
  Returns Promise<string>
  Example
```
import { publicDir } from '@tauri-apps/api/path';
const publicDirPath = await publicDir();
```
  Since
  1.0.0

resolve

resolve: ((...paths: string[]) => Promise<string>)

Type declaration

(...paths): Promise<string>

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

Parameters

Rest...paths: string[]

Returns Promise<string>

Example

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

resolveResource

resolveResource: ((resourcePath: string) => Promise<string>)

Type declaration

- (resourcePath): Promise<string>
- Resolve the path to a resource file.
  Parameters
  - resourcePath: string
    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 Promise<string>
  The full path to the resource.
  Example
```
import { resolveResource } from '@tauri-apps/api/path';
const resourcePath = await resolveResource('script.sh');
```
  Since
  1.0.0

resourceDir

resourceDir: (() => Promise<string>)

Type declaration

- (): Promise<string>
- Returns the path to the application's resource directory. To resolve a resource path, see the [[resolveResource | resolveResource API]].
  
  Returns Promise<string>
  Example
```
import { resourceDir } from '@tauri-apps/api/path';
const resourceDirPath = await resourceDir();
```
  Since
  1.0.0

runtimeDir

runtimeDir: (() => Promise<string>)

Type declaration

- (): 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.
  Returns Promise<string>
  Example
```
import { runtimeDir } from '@tauri-apps/api/path';
const runtimeDirPath = await runtimeDir();
```
  Since
  1.0.0

sep

sep: (() => Promise<string>)

tempDir

tempDir: (() => Promise<string>)

Type declaration

(): Promise<string>

Returns a temporary directory.

Returns Promise<string>

Example

import { tempDir } from '@tauri-apps/api/path';
const temp = await tempDir();

Since

2.0.0

templateDir

templateDir: (() => Promise<string>)

Type declaration

- (): Promise<string>
- Returns the path to the user's template directory.
  
  Platform-specific
  - Linux: Resolves to xdg-user-dirs' XDG_TEMPLATES_DIR.
  - macOS: Not supported.
  - Windows: Resolves to {FOLDERID_Templates}.
  Returns Promise<string>
  Example
```
import { templateDir } from '@tauri-apps/api/path';
const templateDirPath = await templateDir();
```
  Since
  1.0.0

videoDir

videoDir: (() => Promise<string>)

Type declaration

- (): Promise<string>
- Returns the path to the user's video directory.
  
  Platform-specific
  - Linux: Resolves to xdg-user-dirs' XDG_VIDEOS_DIR.
  - macOS: Resolves to $HOME/Movies.
  - Windows: Resolves to {FOLDERID_Videos}.
  Returns Promise<string>
  Example
```
import { videoDir } from '@tauri-apps/api/path';
const videoDirPath = await videoDir();
```
  Since
  1.0.0

Interface IPath

Index

Properties

Properties

BaseDirectory

appCacheDir

Type declaration

Returns Promise<string>

Example

Since

appConfigDir

Type declaration

Returns Promise<string>

Example

Since

appDataDir

Type declaration

Returns Promise<string>

Example

Since

appLocalDataDir

Type declaration

Returns Promise<string>

Example

Since

appLogDir

Type declaration

Platform-specific

Returns Promise<string>

Example

Since

audioDir

Type declaration

Platform-specific

Returns Promise<string>

Example

Since

basename

Type declaration

Parameters

Returns Promise<string>

Example

Since

cacheDir

Type declaration

Platform-specific

Returns Promise<string>

Example

Since

configDir

Type declaration

Platform-specific

Returns Promise<string>

Example

Since

dataDir

Type declaration

Platform-specific

Returns Promise<string>

Example

Since

delimiter

desktopDir

Type declaration

Platform-specific

Returns Promise<string>

Example

Since

dirname

Type declaration

Parameters

Returns Promise<string>

Example

Since

documentDir

Type declaration

Returns Promise<string>

Example

Platform-specific

Since