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
026606391b9b7ebb30df41bb00383b970af4ce37
archived-tauri-docs/docs/api/js/modules/path.md
tauri 026606391b chore(docs): Update Rust & TS docs (#525)
2022-03-29 07:36:52 +02:00

12 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 tauri.conf.json > build > withGlobalTauri is set to true.

The APIs must be allowlisted on 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:449

sep

• Const sep: "\\" | "/"

Provides the platform-specific path segment separator:

  • \ on Windows
  • / on POSIX

Defined in

path.ts:442

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 configured on tauri.conf.json > tauri > bundle > identifier.

Returns

Promise<string>

Defined in

path.ts:36

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

Returns

Promise<string>

Defined in

path.ts:58

basename

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

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

Parameters

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

Returns

Promise<string>

Defined in

path.ts:525

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

Returns

Promise<string>

Defined in

path.ts:80

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

Returns

Promise<string>

Defined in

path.ts:102

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

Returns

Promise<string>

Defined in

path.ts:124

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

Returns

Promise<string>

Defined in

path.ts:146

dirname

▸ dirname(path): Promise<string>

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

Parameters

Name Type
path string

Returns

Promise<string>

Defined in

path.ts:497

documentDir

▸ documentDir(): Promise<string>

Returns the path to the user's document directory.

Platform-specific

  • Linux: Resolves to xdg-user-dirs' XDG_DOCUMENTS_DIR.
  • macOS: Resolves to $HOME/Documents.
  • Windows: Resolves to {FOLDERID_Documents}.

Returns

Promise<string>

Defined in

path.ts:168

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

Returns

Promise<string>

Defined in

path.ts:190

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.

Returns

Promise<string>

Defined in

path.ts:212

extname

▸ extname(path): Promise<string>

Returns the extension of the path.

Parameters

Name Type
path string

Returns

Promise<string>

Defined in

path.ts:510

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.

Returns

Promise<string>

Defined in

path.ts:234

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

Returns

Promise<string>

Defined in

path.ts:256

isAbsolute

▸ isAbsolute(path): Promise<boolean>

Parameters

Name Type
path string

Returns

Promise<boolean>

Defined in

path.ts:536

join

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

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

Parameters

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

Returns

Promise<string>

Defined in

path.ts:484

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

Returns

Promise<string>

Defined in

path.ts:278

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

Returns

Promise<string>

Defined in

path.ts:426

normalize

▸ normalize(path): Promise<string>

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

Parameters

Name Type
path string

Returns

Promise<string>

Defined in

path.ts:469

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

Returns

Promise<string>

Defined in

path.ts:300

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

Returns

Promise<string>

Defined in

path.ts:322

resolve

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

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

Parameters

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

Returns

Promise<string>

Defined in

path.ts:456

resourceDir

▸ resourceDir(): Promise<string>

Returns the path to the user's resource directory.

Returns

Promise<string>

Defined in

path.ts:338

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.

Returns

Promise<string>

Defined in

path.ts:360

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

Returns

Promise<string>

Defined in

path.ts:382

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

Returns

Promise<string>

Defined in

path.ts:404