path

path 模块提供用于处理文件和目录路径的实用程序。

当 tauri.conf.json 中 app.withGlobalTauri 设置为 true 时，此包也可通过 window.__TAURI__.path 访问。

建议只允许您使用的 API，以优化包大小和安全性。

枚举

BaseDirectory

始于

2.0.0

枚举成员

AppCache

AppCache: 16;

查看

appCacheDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L83

AppConfig

AppConfig: 13;

查看

appConfigDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L71

AppData

AppData: 14;

查看

appDataDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L75

AppLocalData

AppLocalData: 15;

查看

appLocalDataDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L79

AppLog

AppLog: 17;

查看

appLogDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L87

Audio

Audio: 1;

查看

audioDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L23

Cache

Cache: 2;

查看

cacheDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L27

Config

Config: 3;

查看

configDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L31

Data

Data: 4;

查看

dataDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L35

Desktop

Desktop: 18;

查看

desktopDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L91

Document

Document: 6;

查看

documentDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L43

Download

Download: 7;

查看

downloadDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L47

Executable

Executable: 19;

查看

executableDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L95

Font

Font: 20;

查看

fontDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L99

Home

Home: 21;

查看

homeDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L103

LocalData

LocalData: 5;

查看

localDataDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L39

Picture

Picture: 8;

查看

pictureDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L51

Public

Public: 9;

查看

publicDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L55

Resource

Resource: 11;

查看

resourceDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L63

Runtime

Runtime: 22;

查看

runtimeDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L107

Temp

Temp: 12;

查看

tempDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L67

Template

Template: 23;

查看

templateDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L111

Video

Video: 10;

查看

videoDir 获取更多信息。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L59

函数

appCacheDir()

function appCacheDir(): Promise<string>

返回应用程序缓存文件的建议目录路径。解析为 ${cacheDir}/${bundleIdentifier}，其中 bundleIdentifier 是 tauri.conf.json 中配置的 identifier 值。

返回

Promise<string>

示例

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

始于

1.2.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L176

---

appConfigDir()

function appConfigDir(): Promise<string>

返回应用程序配置文件的建议目录路径。解析为 ${configDir}/${bundleIdentifier}，其中 bundleIdentifier 是 tauri.conf.json 中配置的 identifier 值。

返回

Promise<string>

示例

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

始于

1.2.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L125

---

appDataDir()

function appDataDir(): Promise<string>

返回应用程序数据文件的建议目录路径。解析为 ${dataDir}/${bundleIdentifier}，其中 bundleIdentifier 是 tauri.conf.json 中配置的 identifier 值。

返回

Promise<string>

示例

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

始于

1.2.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L142

---

appLocalDataDir()

function appLocalDataDir(): Promise<string>

返回应用程序本地数据文件的建议目录路径。解析为 ${localDataDir}/${bundleIdentifier}，其中 bundleIdentifier 是 tauri.conf.json 中配置的 identifier 值。

返回

Promise<string>

示例

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

始于

1.2.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L159

---

appLogDir()

function appLogDir(): Promise<string>

返回应用程序日志文件的建议目录路径。

平台特定

• Linux: 解析为 ${configDir}/${bundleIdentifier}/logs。
• macOS: 解析为 ${homeDir}/Library/Logs/{bundleIdentifier}
• Windows: 解析为 ${configDir}/${bundleIdentifier}/logs。

返回

Promise<string>

示例

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

始于

1.2.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L604

---

audioDir()

function audioDir(): Promise<string>

返回用户音频目录的路径。

平台特定

• Linux: 解析为 xdg-user-dirs 的 XDG_MUSIC_DIR。
• macOS: 解析为 $HOME/Music。
• Windows: 解析为 {FOLDERID_Music}。

返回

Promise<string>

示例

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

始于

1.0.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L198

---

basename()

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

返回 path 的最后一部分。忽略尾随目录分隔符。

参数

参数	类型	描述
path	string	-
ext?	string	要从返回路径中删除的可选文件扩展名。

返回

Promise<string>

示例

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

始于

1.0.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L734

---

cacheDir()

function cacheDir(): Promise<string>

返回用户缓存目录的路径。

平台特定

• Linux: 解析为 $XDG_CACHE_HOME 或 $HOME/.cache。
• macOS: 解析为 $HOME/Library/Caches。
• Windows: 解析为 {FOLDERID_LocalAppData}。

返回

Promise<string>

示例

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

始于

1.0.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L220

---

configDir()

function configDir(): Promise<string>

返回用户配置目录的路径。

平台特定

• Linux: 解析为 $XDG_CONFIG_HOME 或 $HOME/.config。
• macOS: 解析为 $HOME/Library/Application Support。
• Windows: 解析为 {FOLDERID_RoamingAppData}。

返回

Promise<string>

示例

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

始于

1.0.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L242

---

dataDir()

function dataDir(): Promise<string>

返回用户数据目录的路径。

平台特定

• Linux: 解析为 $XDG_DATA_HOME 或 $HOME/.local/share。
• macOS: 解析为 $HOME/Library/Application Support。
• Windows: 解析为 {FOLDERID_RoamingAppData}。

返回

Promise<string>

示例

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

始于

1.0.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L264

---

delimiter()

function delimiter(): string

返回平台特定的路径段分隔符

• Windows 上为 ;
• POSIX 上为 :

返回

string

始于

2.0.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L644

---

desktopDir()

function desktopDir(): Promise<string>

返回用户桌面目录的路径。

平台特定

• Linux: 解析为 xdg-user-dirs 的 XDG_DESKTOP_DIR。
• macOS: 解析为 $HOME/Desktop。
• Windows: 解析为 {FOLDERID_Desktop}。

返回

Promise<string>

示例

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

始于

1.0.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L286

---

dirname()

function dirname(path): Promise<string>

返回给定 path 的父目录。忽略尾随目录分隔符。

参数

参数	类型
path	string

返回

Promise<string>

示例

import { dirname } from '@tauri-apps/api/path';
const dir = await dirname('/path/to/somedir/');
assert(dir === '/path/to');

始于

1.0.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L703

---

documentDir()

function documentDir(): Promise<string>

返回用户文档目录的路径。

返回

Promise<string>

示例

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

平台特定

• Linux: 解析为 xdg-user-dirs 的 XDG_DOCUMENTS_DIR。
• macOS: 解析为 $HOME/Documents。
• Windows: 解析为 {FOLDERID_Documents}。

始于

1.0.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L308

---

downloadDir()

function downloadDir(): Promise<string>

返回用户下载目录的路径。

平台特定

• Linux: 解析为 xdg-user-dirs 的 XDG_DOWNLOAD_DIR。
• macOS: 解析为 $HOME/Downloads。
• Windows: 解析为 {FOLDERID_Downloads}。

返回

Promise<string>

示例

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

始于

1.0.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L330

---

executableDir()

function executableDir(): Promise<string>

返回用户可执行目录的路径。

平台特定

• Linux: 解析为 $XDG_BIN_HOME/../bin 或 $XDG_DATA_HOME/../bin 或 $HOME/.local/bin。
• macOS: 不支持。
• Windows: 不支持。

返回

Promise<string>

示例

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

始于

1.0.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L352

---

extname()

function extname(path): Promise<string>

返回 path 的扩展名。

参数

参数	类型
path	string

返回

Promise<string>

示例

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

始于

1.0.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L718

---

fontDir()

function fontDir(): Promise<string>

返回用户字体目录的路径。

平台特定

• Linux: 解析为 $XDG_DATA_HOME/fonts 或 $HOME/.local/share/fonts。
• macOS: 解析为 $HOME/Library/Fonts。
• Windows: 不支持。

返回

Promise<string>

示例

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

始于

1.0.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L374

---

homeDir()

function homeDir(): Promise<string>

返回用户主目录的路径。

平台特定

• Linux: 解析为 $HOME。
• macOS: 解析为 $HOME。
• Windows: 解析为 {FOLDERID_Profile}。

返回

Promise<string>

示例

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

始于

1.0.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L396

---

isAbsolute()

function isAbsolute(path): Promise<boolean>

返回路径是否为绝对路径。

参数

参数	类型
path	string

返回

Promise<boolean>

示例

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

始于

1.0.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L748

---

join()

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

使用平台特定分隔符将所有给定的 path 段连接在一起，然后规范化生成的路径。

参数

参数	类型
...paths	string[]

返回

Promise<string>

示例

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

始于

1.0.0

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L688

---

localDataDir()

function localDataDir(): Promise<string>

返回用户本地数据目录的路径。

平台特定

• Linux: 解析为 $XDG_DATA_HOME 或 $HOME/.local/share。
• macOS: 解析为 $HOME/Library/Application Support。
• Windows: 解析为 {FOLDERID_LocalAppData}。

返回

Promise<string>

示例

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

始于

1.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L418

---

normalize()

function normalize(path): Promise<string>

规范化给定的 path，解析 '..' 和 '.' 段并解析符号链接。

参数

参数	类型
path	string

返回

Promise<string>

示例

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

始于

1.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L673

---

pictureDir()

function pictureDir(): Promise<string>

返回用户图片目录的路径。

平台特定

• Linux：解析为 xdg-user-dirs 的 XDG_PICTURES_DIR。
• macOS：解析为 $HOME/Pictures。
• Windows：解析为 {FOLDERID_Pictures}。

返回

Promise<string>

示例

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

始于

1.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L440

---

publicDir()

function publicDir(): Promise<string>

返回用户公共目录的路径。

平台特定

• Linux：解析为 xdg-user-dirs 的 XDG_PUBLICSHARE_DIR。
• macOS：解析为 $HOME/Public。
• Windows：解析为 {FOLDERID_Public}。

返回

Promise<string>

示例

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

始于

1.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L462

---

resolve()

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

将一系列 paths 或 path 段解析为绝对路径。

参数

参数	类型
...paths	string[]

返回

Promise<string>

示例

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

始于

1.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L658

---

resolveResource()

function resolveResource(resourcePath): Promise<string>

解析资源文件的路径。

参数

参数	类型	描述
资源路径	string	资源的路径。必须遵循 tauri.conf.json > bundle > resources 中定义的相同语法，即保留子文件夹和父目录组件 (../)。

返回

Promise<string>

资源的完整路径。

示例

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

始于

1.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L515

---

resourceDir()

function resourceDir(): Promise<string>

返回应用程序资源目录的路径。要解析资源路径，请参阅 resolveResource。

平台特定

尽管我们提供了此函数解析到的确切路径，但这并非约定，将来可能会有所更改

• Windows：解析到包含主可执行文件的目录。
• Linux：在 AppImage 中运行时，APPDIR 变量将被设置为应用程序的挂载位置，资源目录将是 ${APPDIR}/usr/lib/${exe_name}。如果不在 AppImage 中运行，路径是 /usr/lib/${exe_name}。从 src-tauri/target/(debug|release)/ 运行应用程序时，路径是 ${exe_dir}/../lib/${exe_name}。
• macOS：解析到 ${exe_dir}/../Resources（在 .app 内部）。
• iOS：解析到 ${exe_dir}/assets。
• Android：目前资源作为资产存储在 APK 中，因此它不是一个普通的文件系统路径，我们在此处返回一个特殊的 URI 前缀 asset:///，可与 文件系统插件 一起使用，

返回

Promise<string>

示例

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

始于

1.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L495

---

runtimeDir()

function runtimeDir(): Promise<string>

返回用户运行时目录的路径。

平台特定

• Linux：解析为 $XDG_RUNTIME_DIR。
• macOS: 不支持。
• Windows: 不支持。

返回

Promise<string>

示例

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

始于

1.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L538

---

sep()

function sep(): string

返回平台特定的路径段分隔符

• Windows 上为 \
• POSIX 上为 /

返回

string

始于

2.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L633

---

tempDir()

function tempDir(): Promise<string>

返回一个临时目录。

返回

Promise<string>

示例

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

始于

2.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L620

---

templateDir()

function templateDir(): Promise<string>

返回用户模板目录的路径。

平台特定

• Linux：解析为 xdg-user-dirs 的 XDG_TEMPLATES_DIR。
• macOS: 不支持。
• Windows：解析为 {FOLDERID_Templates}。

返回

Promise<string>

示例

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

始于

1.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L560

---

videoDir()

function videoDir(): Promise<string>

返回用户视频目录的路径。

平台特定

• Linux：解析为 xdg-user-dirs 的 XDG_VIDEOS_DIR。
• macOS：解析为 $HOME/Movies。
• Windows：解析为 {FOLDERID_Videos}。

返回

Promise<string>

示例

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

始于

1.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/path.ts#L582