@zturnlibs/ztron-api

---

path#

Type Aliases#

BaseDirectory#

BaseDirectory = typeof BaseDirectory[keyof typeof BaseDirectory]

Defined in: path.ts:185

Upstream BaseDirectory names (23) — pass to fs/path fns as options.baseDir; values resolve against the directory getters in this module (Tauri strings, e.g. BaseDirectory.AppConfig === "AppConfig").

Variables#

BaseDirectory#

const BaseDirectory: object

Defined in: path.ts:185

Upstream BaseDirectory names (23) — pass to fs/path fns as options.baseDir; values resolve against the directory getters in this module (Tauri strings, e.g. BaseDirectory.AppConfig === "AppConfig").

Type Declaration#

AppCache#

readonly AppCache: "AppCache" = "AppCache"

AppConfig#

readonly AppConfig: "AppConfig" = "AppConfig"

AppData#

readonly AppData: "AppData" = "AppData"

AppLocalData#

readonly AppLocalData: "AppLocalData" = "AppLocalData"

AppLog#

readonly AppLog: "AppLog" = "AppLog"

Audio#

readonly Audio: "Audio" = "Audio"

Cache#

readonly Cache: "Cache" = "Cache"

Config#

readonly Config: "Config" = "Config"

Data#

readonly Data: "Data" = "Data"

Desktop#

readonly Desktop: "Desktop" = "Desktop"

Document#

readonly Document: "Document" = "Document"

Download#

readonly Download: "Download" = "Download"

Executable#

readonly Executable: "Executable" = "Executable"

Font#

readonly Font: "Font" = "Font"

Home#

readonly Home: "Home" = "Home"

LocalData#

readonly LocalData: "LocalData" = "LocalData"

Picture#

readonly Picture: "Picture" = "Picture"

Public#

readonly Public: "Public" = "Public"

Resource#

readonly Resource: "Resource" = "Resource"

Runtime#

readonly Runtime: "Runtime" = "Runtime"

Temp#

readonly Temp: "Temp" = "Temp"

Template#

readonly Template: "Template" = "Template"

Video#

readonly Video: "Video" = "Video"

---

delimiter#

const delimiter: ":" = ":"

Defined in: path.ts:132

Path list separator in PATH-style variables: : on POSIX, ; on Windows.

---

path#

const path: object

Defined in: path.ts:142

Type Declaration#

appCacheDir#

appCacheDir: () => Promise<string>

Returns#

Promise<string>

appConfigDir#

appConfigDir: () => Promise<string>

Returns#

Promise<string>

appDataDir#

appDataDir: () => Promise<string>

App-specific data directory.

Returns#

Promise<string>

appLocalDataDir#

appLocalDataDir: () => Promise<string>

Returns#

Promise<string>

appLogDir#

appLogDir: () => Promise<string>

Returns#

Promise<string>

audioDir#

audioDir: () => Promise<string>

Returns#

Promise<string>

baselineDir#

baselineDir: () => Promise<string>

Returns#

Promise<string>

basename#

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

Parameters#

path#

string

ext?#

string

Returns#

Promise<string>

cacheDir#

cacheDir: () => Promise<string>

Returns#

Promise<string>

configDir#

configDir: () => Promise<string>

Returns#

Promise<string>

cwd#

cwd: () => Promise<string>

The current working directory.

Returns#

Promise<string>

dataDir#

dataDir: () => Promise<string>

Returns#

Promise<string>

delimiter#

delimiter: string

Path list separator in PATH-style variables: : on POSIX, ; on Windows.

desktopDir#

desktopDir: () => Promise<string>

Returns#

Promise<string>

dirname#

dirname: (path) => Promise<string>

Parameters#

path#

string

Returns#

Promise<string>

documentDir#

documentDir: () => Promise<string>

Returns#

Promise<string>

downloadDir#

downloadDir: () => Promise<string>

Returns#

Promise<string>

executableDir#

executableDir: () => Promise<string>

Returns#

Promise<string>

extname#

extname: (path) => Promise<string>

Parameters#

path#

string

Returns#

Promise<string>

fontDir#

fontDir: () => Promise<string>

Returns#

Promise<string>

homeDir#

homeDir: () => Promise<string>

The user's home directory.

Returns#

Promise<string>

isAbsolute#

isAbsolute: (path) => Promise<boolean>

Parameters#

path#

string

Returns#

Promise<boolean>

join#

join: (...parts) => Promise<string>

Parameters#

parts#

...string[]

Returns#

Promise<string>

localDataDir#

localDataDir: () => Promise<string>

Tauri v2 name for appLocalDataDir (kept as an alias — Tauri's own JS API exposes both).

Returns#

Promise<string>

normalize#

normalize: (path) => Promise<string>

Parameters#

path#

string

Returns#

Promise<string>

pictureDir#

pictureDir: () => Promise<string>

Returns#

Promise<string>

publicDir#

publicDir: () => Promise<string>

Returns#

Promise<string>

resolve#

resolve: (path) => Promise<string>

Parameters#

path#

string

Returns#

Promise<string>

resolveResource#

resolveResource: (resourcePath) => Promise<string>

Resolves a bundled asset path against the resource directory — the Tauri v2 resolveResource(resourcePath, base?) (formerly resolveResource). Absolute paths pass through unchanged.

Parameters#

resourcePath#

string

Returns#

Promise<string>

resourceDir#

resourceDir: () => Promise<string>

Returns#

Promise<string>

runtimeDir#

runtimeDir: () => Promise<string>

Returns#

Promise<string>

sep#

sep: string

Path fragment separator: / on POSIX, \\ on Windows.

tempDir#

tempDir: () => Promise<string>

The system temporary directory.

Returns#

Promise<string>

templateDir#

templateDir: () => Promise<string>

Returns#

Promise<string>

videoDir#

videoDir: () => Promise<string>

Returns#

Promise<string>

---

sep#

const sep: "/" = "/"

Defined in: path.ts:129

Path fragment separator: / on POSIX, \\ on Windows.

Functions#

appCacheDir()#

appCacheDir(): Promise<string>

Defined in: path.ts:57

Returns#

Promise<string>

---

appConfigDir()#

appConfigDir(): Promise<string>

Defined in: path.ts:54

Returns#

Promise<string>

---

appDataDir()#

appDataDir(): Promise<string>

Defined in: path.ts:51

App-specific data directory.

Returns#

Promise<string>

---

appLocalDataDir()#

appLocalDataDir(): Promise<string>

Defined in: path.ts:60

Returns#

Promise<string>

---

appLogDir()#

appLogDir(): Promise<string>

Defined in: path.ts:63

Returns#

Promise<string>

---

audioDir()#

audioDir(): Promise<string>

Defined in: path.ts:93

Returns#

Promise<string>

---

baselineDir()#

baselineDir(): Promise<string>

Defined in: path.ts:66

Returns#

Promise<string>

---

basename()#

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

Defined in: path.ts:23

Parameters#

path#

string

ext?#

string

Returns#

Promise<string>

---

cacheDir()#

cacheDir(): Promise<string>

Defined in: path.ts:75

Returns#

Promise<string>

---

configDir()#

configDir(): Promise<string>

Defined in: path.ts:72

Returns#

Promise<string>

---

cwd()#

cwd(): Promise<string>

Defined in: path.ts:46

The current working directory.

Returns#

Promise<string>

---

dataDir()#

dataDir(): Promise<string>

Defined in: path.ts:69

Returns#

Promise<string>

---

desktopDir()#

desktopDir(): Promise<string>

Defined in: path.ts:81

Returns#

Promise<string>

---

dirname()#

dirname(path): Promise<string>

Defined in: path.ts:27

Parameters#

path#

string

Returns#

Promise<string>

---

documentDir()#

documentDir(): Promise<string>

Defined in: path.ts:84

Returns#

Promise<string>

---

downloadDir()#

downloadDir(): Promise<string>

Defined in: path.ts:87

Returns#

Promise<string>

---

executableDir()#

executableDir(): Promise<string>

Defined in: path.ts:108

Returns#

Promise<string>

---

extname()#

extname(path): Promise<string>

Defined in: path.ts:31

Parameters#

path#

string

Returns#

Promise<string>

---

fontDir()#

fontDir(): Promise<string>

Defined in: path.ts:78

Returns#

Promise<string>

---

homeDir()#

homeDir(): Promise<string>

Defined in: path.ts:36

The user's home directory.

Returns#

Promise<string>

---

isAbsolute()#

isAbsolute(path): Promise<boolean>

Defined in: path.ts:19

Parameters#

path#

string

Returns#

Promise<boolean>

---

join()#

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

Defined in: path.ts:7

Parameters#

parts#

...string[]

Returns#

Promise<string>

---

localDataDir()#

localDataDir(): Promise<string>

Defined in: path.ts:138

Tauri v2 name for appLocalDataDir (kept as an alias — Tauri's own JS API exposes both).

Returns#

Promise<string>

---

normalize()#

normalize(path): Promise<string>

Defined in: path.ts:15

Parameters#

path#

string

Returns#

Promise<string>

---

pictureDir()#

pictureDir(): Promise<string>

Defined in: path.ts:90

Returns#

Promise<string>

---

publicDir()#

publicDir(): Promise<string>

Defined in: path.ts:99

Returns#

Promise<string>

---

resolve()#

resolve(path): Promise<string>

Defined in: path.ts:11

Parameters#

path#

string

Returns#

Promise<string>

---

resolveBaseDirectory()#

resolveBaseDirectory(base): Promise<string>

Defined in: path.ts:213

Resolves a BaseDirectory name to its absolute path.

Parameters#

base#

string

Returns#

Promise<string>

---

resolveResource()#

resolveResource(resourcePath): Promise<string>

Defined in: path.ts:120

Resolves a bundled asset path against the resource directory — the Tauri v2 resolveResource(resourcePath, base?) (formerly resolveResource). Absolute paths pass through unchanged.

Parameters#

resourcePath#

string

Returns#

Promise<string>

---

resourceDir()#

resourceDir(): Promise<string>

Defined in: path.ts:111

Returns#

Promise<string>

---

runtimeDir()#

runtimeDir(): Promise<string>

Defined in: path.ts:105

Returns#

Promise<string>

---

tempDir()#

tempDir(): Promise<string>

Defined in: path.ts:41

The system temporary directory.

Returns#

Promise<string>

---

templateDir()#

templateDir(): Promise<string>

Defined in: path.ts:102

Returns#

Promise<string>

---

videoDir()#

videoDir(): Promise<string>

Defined in: path.ts:96

Returns#

Promise<string>