path

Devuelve la ruta al directorio sugerido para los archivos de caché de tu app. Se resuelve en ${cacheDir}/${bundleIdentifier}, donde bundleIdentifier es el valor de identifier configurado en tauri.conf.json.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.2.0

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

appConfigDir()

function appConfigDir(): Promise<string>

Devuelve la ruta al directorio sugerido para los archivos de configuración de tu app. Se resuelve en ${configDir}/${bundleIdentifier}, donde bundleIdentifier es el valor de identifier configurado en tauri.conf.json.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.2.0

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

appDataDir()

function appDataDir(): Promise<string>

Devuelve la ruta al directorio sugerido para los archivos de datos de tu app. Se resuelve en ${dataDir}/${bundleIdentifier}, donde bundleIdentifier es el valor de identifier configurado en tauri.conf.json.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.2.0

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

appLocalDataDir()

function appLocalDataDir(): Promise<string>

Devuelve la ruta al directorio sugerido para los archivos de datos locales de tu app. Se resuelve en ${localDataDir}/${bundleIdentifier}, donde bundleIdentifier es el valor de identifier configurado en tauri.conf.json.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.2.0

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

appLogDir()

function appLogDir(): Promise<string>

Devuelve la ruta al directorio sugerido para los archivos de registros (logs) de tu app.

Específico de la plataforma

Linux: Se resuelve en ${configDir}/${bundleIdentifier}/logs.
macOS: Se resuelve en ${homeDir}/Library/Logs/{bundleIdentifier}
Windows: Se resuelve en ${configDir}/${bundleIdentifier}/logs.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.2.0

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

audioDir()

function audioDir(): Promise<string>

Devuelve la ruta al directorio de audio del usuario.

Específico de la plataforma

Linux: Se resuelve en XDG_MUSIC_DIR de xdg-user-dirs.
macOS: Se resuelve en $HOME/Music.
Windows: Se resuelve en {FOLDERID_Music}.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

basename()

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

Devuelve la última porción de una ruta. Se ignoran los separadores de directorio finales.

Parámetros

Parámetro	Tipo	Descripción
`path`	`string`	-
`ext`?	`string`	Una extensión de archivo opcional que se eliminará de la ruta devuelta.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

cacheDir()

function cacheDir(): Promise<string>

Devuelve la ruta al directorio de caché del usuario.

Específico de la plataforma

Linux: Se resuelve en $XDG_CACHE_HOME o $HOME/.cache.
macOS: Se resuelve en $HOME/Library/Caches.
Windows: Se resuelve en {FOLDERID_LocalAppData}.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

configDir()

function configDir(): Promise<string>

Devuelve la ruta al directorio de configuración del usuario.

Específico de la plataforma

Linux: Se resuelve en $XDG_CONFIG_HOME o $HOME/.config.
macOS: Se resuelve en $HOME/Library/Application Support.
Windows: Se resuelve en {FOLDERID_RoamingAppData}.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

dataDir()

function dataDir(): Promise<string>

Devuelve la ruta al directorio de datos del usuario.

Específico de la plataforma

Linux: Se resuelve en $XDG_DATA_HOME o $HOME/.local/share.
macOS: Se resuelve en $HOME/Library/Application Support.
Windows: Se resuelve en {FOLDERID_RoamingAppData}.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

delimiter()

function delimiter(): string

Devuelve el delimitador de segmentos de ruta específico de la plataforma:

; en Windows
: en POSIX

Devuelve

string

Desde

2.0.0

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

desktopDir()

function desktopDir(): Promise<string>

Devuelve la ruta al directorio del escritorio del usuario.

Específico de la plataforma

Linux: Se resuelve en XDG_DESKTOP_DIR de xdg-user-dirs.
macOS: Se resuelve en $HOME/Desktop.
Windows: Se resuelve en {FOLDERID_Desktop}.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

dirname()

function dirname(path): Promise<string>

Devuelve el directorio padre de una ruta dada. Se ignoran los separadores de directorio finales.

Parámetros

Parámetro	Tipo
`path`	`string`

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

documentDir()

function documentDir(): Promise<string>

Devuelve la ruta al directorio de documentos del usuario.

Devuelve

Promise<string>

Ejemplo

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

Específico de la plataforma

Linux: Se resuelve en XDG_DOCUMENTS_DIR de xdg-user-dirs.
macOS: Se resuelve en $HOME/Documents.
Windows: Se resuelve en {FOLDERID_Documents}.

Desde

1.0.0

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

downloadDir()

function downloadDir(): Promise<string>

Devuelve la ruta al directorio de descargas del usuario.

Específico de la plataforma

Linux: Se resuelve en XDG_DOWNLOAD_DIR de xdg-user-dirs.
macOS: Se resuelve en $HOME/Downloads.
Windows: Se resuelve en {FOLDERID_Downloads}.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

executableDir()

function executableDir(): Promise<string>

Devuelve la ruta al directorio de ejecutables del usuario.

Específico de la plataforma

Linux: Se resuelve en $XDG_BIN_HOME/../bin o $XDG_DATA_HOME/../bin o $HOME/.local/bin.
macOS: No soportado.
Windows: No soportado.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

extname()

function extname(path): Promise<string>

Devuelve la extensión de la ruta.

Parámetros

Parámetro	Tipo
`path`	`string`

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

fontDir()

function fontDir(): Promise<string>

Devuelve la ruta al directorio de fuentes (fonts) del usuario.

Específico de la plataforma

Linux: Se resuelve en $XDG_DATA_HOME/fonts o $HOME/.local/share/fonts.
macOS: Se resuelve en $HOME/Library/Fonts.
Windows: No soportado.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

homeDir()

function homeDir(): Promise<string>

Devuelve la ruta al directorio personal (home) del usuario.

Específico de la plataforma

Linux: Se resuelve en $HOME.
macOS: Se resuelve en $HOME.
Windows: Se resuelve en {FOLDERID_Profile}.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

isAbsolute()

function isAbsolute(path): Promise<boolean>

Devuelve si la ruta es absoluta o no.

Parámetros

Parámetro	Tipo
`path`	`string`

Devuelve

Promise<boolean>

Ejemplo

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

Desde

1.0.0

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

join()

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

Une todos los segmentos de ruta dados utilizando el separador específico de la plataforma como delimitador y luego normaliza la ruta resultante.

Parámetros

Parámetro	Tipo
…`paths`	`string`[]

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

localDataDir()

function localDataDir(): Promise<string>

Devuelve la ruta al directorio de datos locales del usuario.

Específico de la plataforma

Linux: Se resuelve en $XDG_DATA_HOME o $HOME/.local/share.
macOS: Se resuelve en $HOME/Library/Application Support.
Windows: Se resuelve en {FOLDERID_LocalAppData}.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

normalize()

function normalize(path): Promise<string>

Normaliza la ruta dada, resolviendo los segmentos '..' y '.' y resolviendo enlaces simbólicos.

Parámetros

Parámetro	Tipo
`path`	`string`

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

pictureDir()

function pictureDir(): Promise<string>

Devuelve la ruta al directorio de imágenes del usuario.

Específico de la plataforma

Linux: Se resuelve en XDG_PICTURES_DIR de xdg-user-dirs.
macOS: Se resuelve en $HOME/Pictures.
Windows: Se resuelve en {FOLDERID_Pictures}.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

publicDir()

function publicDir(): Promise<string>

Devuelve la ruta al directorio público del usuario.

Específico de la plataforma

Linux: Se resuelve en XDG_PUBLICSHARE_DIR de xdg-user-dirs.
macOS: Se resuelve en $HOME/Public.
Windows: Se resuelve en {FOLDERID_Public}.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

resolve()

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

Resuelve una secuencia de rutas o segmentos de ruta en una ruta absoluta.

Parámetros

Parámetro	Tipo
…`paths`	`string`[]

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

resolveResource()

function resolveResource(resourcePath): Promise<string>

Resuelve la ruta a un archivo de recurso.

Parámetros

Parámetro	Tipo	Descripción
`resourcePath`	`string`	La ruta al recurso. Debe seguir la misma sintaxis definida en `tauri.conf.json > bundle > resources`, es decir, manteniendo las subcarpetas y los componentes del directorio padre (`../`).

Devuelve

Promise<string>

La ruta completa al recurso.

Ejemplo

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

Desde

1.0.0

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

resourceDir()

function resourceDir(): Promise<string>

Devuelve la ruta al directorio de recursos de la aplicación. Para resolver una ruta de recurso, consulta resolveResource.

Específico de la plataforma

Aunque proporcionamos la ruta exacta a la que se resuelve esta función, esto no es un contrato y las cosas podrían cambiar en el futuro

Windows: Se resuelve en el directorio que contiene el ejecutable principal.
Linux: Cuando se ejecuta en una AppImage, la variable APPDIR se establecerá en la ubicación montada de la app, y el directorio de recursos será ${APPDIR}/usr/lib/${exe_name}. Si no se ejecuta en una AppImage, la ruta es /usr/lib/${exe_name}. Cuando se ejecuta la app desde src-tauri/target/(debug|release)/, la ruta es ${exe_dir}/../lib/${exe_name}.
macOS: Se resuelve en ${exe_dir}/../Resources (dentro de .app).
iOS: Se resuelve en ${exe_dir}/assets.
Android: Actualmente los recursos se almacenan en el APK como assets por lo que no es una ruta normal del sistema de archivos, aquí devolvemos un prefijo de URI especial asset://localhost/ que se puede usar con el plugin del sistema de archivos,

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

runtimeDir()

function runtimeDir(): Promise<string>

Devuelve la ruta al directorio de tiempo de ejecución (runtime) del usuario.

Específico de la plataforma

Linux: Se resuelve en $XDG_RUNTIME_DIR.
macOS: No soportado.
Windows: No soportado.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

sep()

function sep(): string

Devuelve el separador de segmentos de ruta específico de la plataforma:

\ en Windows
/ en POSIX

Devuelve

string

Desde

2.0.0

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

tempDir()

function tempDir(): Promise<string>

Devuelve un directorio temporal.

Devuelve

Promise<string>

Ejemplo

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

Desde

2.0.0

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

templateDir()

function templateDir(): Promise<string>

Devuelve la ruta al directorio de plantillas del usuario.

Específico de la plataforma

Linux: Se resuelve en XDG_TEMPLATES_DIR de xdg-user-dirs.
macOS: No soportado.
Windows: Se resuelve en {FOLDERID_Templates}.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

videoDir()

function videoDir(): Promise<string>

Devuelve la ruta al directorio de videos del usuario.

Específico de la plataforma

Linux: Se resuelve en XDG_VIDEOS_DIR de xdg-user-dirs.
macOS: Se resuelve en $HOME/Movies.
Windows: Se resuelve en {FOLDERID_Videos}.

Devuelve

Promise<string>

Ejemplo

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

Desde

1.0.0

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

Apoya en Open Collective Patrocina en GitHub