tauri-apps/archived-tauri-docs
1
0
Fork 0
mirror of https://github.com/tauri-apps/tauri-docs.git synced 2026-01-31 00:35:16 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
514b66e3a409deb41b1847b9588284ff07d8db3f
archived-tauri-docs/docs/api/js/modules/path.md
tauri 6ffe6516d8 chore(docs): Update Rust & TS docs (#770) 
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2022-07-15 12:00:05 +02:00

14 KiB
Raw Blame History

@tauri-apps/api / path

Module: path

The path module provides utilities for working with file and directory paths.

This package is also accessible with window.__TAURI__.path when build.withGlobalTauri in tauri.conf.json is set to true.

The APIs must be added to tauri.allowlist.path in tauri.conf.json:

{
  "tauri": {
    "allowlist": {
      "path": {
        "all": true, // enable all Path APIs
      }
    }
  }
}

It is recommended to allowlist only the APIs you use for optimal bundle size and security.

References

BaseDirectory

Re-exports BaseDirectory

Variables

delimiter

Const delimiter: ";" | ":"

Provides the platform-specific path segment delimiter:

  • ; on Windows
  • : on POSIX

Defined in

path.ts:568

sep

Const sep: "\\" | "/"

Provides the platform-specific path segment separator:

  • \ on Windows
  • / on POSIX

Defined in

path.ts:561

Functions

appDir

appDir(): Promise<string>

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

Example

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

Returns

Promise<string>

audioDir

audioDir(): 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}.

Example

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

Returns

Promise<string>

basename

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

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

Example

import { basename, resolveResource } from '@tauri-apps/api/path';
const resourcePath = await resolveResource('app.conf');
const base = await basename(resourcePath);
assert(base === 'app');

Parameters

Name Type Description
path string -
ext? string An optional file extension to be removed from the returned path.

Returns

Promise<string>

cacheDir

cacheDir(): 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

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

Returns

Promise<string>

configDir

configDir(): 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

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

Returns

Promise<string>

dataDir

dataDir(): 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

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

Returns

Promise<string>

desktopDir

desktopDir(): 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/Library/Desktop.
  • Windows: Resolves to {FOLDERID_Desktop}.

Example

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

Returns

Promise<string>

dirname

dirname(path): Promise<string>

Returns the directory name of a path. Trailing directory separators are ignored.

Example

import { dirname, appDir } from '@tauri-apps/api/path';
const appDirPath = await appDir();
const dir = await dirname(appDirPath);

Parameters

Name Type
path string

Returns

Promise<string>

documentDir

documentDir(): Promise<string>

Returns the path to the user's document directory.

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}.

Returns

Promise<string>

downloadDir

downloadDir(): 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}.

Example

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

Returns

Promise<string>

executableDir

executableDir(): 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

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

Returns

Promise<string>

extname

extname(path): Promise<string>

Returns the extension of the path.

Example

import { extname, resolveResource } from '@tauri-apps/api/path';
const resourcePath = await resolveResource('app.conf');
const ext = await extname(resourcePath);
assert(ext === 'conf');

Parameters

Name Type
path string

Returns

Promise<string>

fontDir

fontDir(): 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

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

Returns

Promise<string>

homeDir

homeDir(): 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

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

Returns

Promise<string>

isAbsolute

isAbsolute(path): Promise<boolean>

Returns whether the path is absolute or not.

Example

import { isAbsolute } from '@tauri-apps/api/path';
assert(await isAbsolute('/home/tauri'));

Parameters

Name Type
path string

Returns

Promise<boolean>

join

join(...paths): Promise<string>

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

Example

import { join, appDir } from '@tauri-apps/api/path';
const appDirPath = await appDir();
const path = await join(appDirPath, 'users', 'tauri', 'avatar.png');

Parameters

Name Type Description
...paths string[] A sequence of path segments.

Returns

Promise<string>

localDataDir

localDataDir(): 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

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

Returns

Promise<string>

logDir

logDir(): Promise<string>

Returns the path to the suggested log directory.

Platform-specific

  • Linux: Resolves to ${configDir}/${bundleIdentifier}.
  • macOS: Resolves to ${homeDir}//Library/Logs/{bundleIdentifier}
  • Windows: Resolves to ${configDir}/${bundleIdentifier}.

Example

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

Returns

Promise<string>

normalize

normalize(path): Promise<string>

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

Example

import { normalize, appDir } from '@tauri-apps/api/path';
const appDirPath = await appDir();
const path = await normalize(appDirPath, '..', 'users', 'tauri', 'avatar.png');

Parameters

Name Type
path string

Returns

Promise<string>

pictureDir

pictureDir(): 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}.

Example

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

Returns

Promise<string>

publicDir

publicDir(): 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}.

Example

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

Returns

Promise<string>

resolve

resolve(...paths): Promise<string>

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

Example

import { resolve, appDir } from '@tauri-apps/api/path';
const appDirPath = await appDir();
const path = await resolve(appDirPath, '..', 'users', 'tauri', 'avatar.png');

Parameters

Name Type Description
...paths string[] A sequence of paths or path segments.

Returns

Promise<string>

resolveResource

resolveResource(resourcePath): Promise<string>

Resolve the path to a resource file.

Example

import { resolveResource } from '@tauri-apps/api/path';
const resourcePath = await resolveResource('script.sh');

Parameters

Name Type Description
resourcePath string The path to the resource. Must follow the same syntax as defined in tauri.conf.json > tauri > bundle > resources, i.e. keeping subfolders and parent dir components (../).

Returns

Promise<string>

The full path to the resource.

resourceDir

resourceDir(): Promise<string>

Returns the path to the application's resource directory. To resolve a resource path, see the [[resolveResource | resolveResource API]].

Example

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

Returns

Promise<string>

runtimeDir

runtimeDir(): 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

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

Returns

Promise<string>

templateDir

templateDir(): 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}.

Example

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

Returns

Promise<string>

videoDir

videoDir(): 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}.

Example

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

Returns

Promise<string>