@tauri-apps/plugin-fs

Accede al sistema de archivos.

Recursos con alcance de seguridad de iOS

En iOS, el plugin fs gestiona automáticamente el acceso a los recursos con alcance de seguridad cuando se accede a una URL de archivo. Esto es necesario para archivos fuera del sandbox de la aplicación (por ejemplo, desde el selector de archivos).

Ejemplo

import { open } from '@tauri-apps/plugin-fs';

const file = await open('file:///path/to/file.txt');
await file.close();

Seguridad

Este módulo evita el recorrido de rutas (path traversal), no permitiendo que se usen accesores de directorio primario (es decir, no se permiten rutas como “/usr/path/to/../file” o “../path/to/file”). Las rutas accedidas con esta API deben ser relativas a uno de los directorios base o crearse con la API path.

La API tiene una configuración de alcance (scope) que te obliga a restringir las rutas a las que se puede acceder utilizando patrones glob.

La configuración de alcance (scope) es un array de patrones glob que describen las rutas de archivos/directorios permitidas. Por ejemplo, esta configuración de alcance permite que todas las API fs habilitadas accedan (únicamente) a archivos en el directorio databases del directorio $APPDATA:

{
  "permissions": [
    {
      "identifier": "fs:scope",
      "allow": [{ "path": "$APPDATA/databases/*" }]
    }
  ]
}

Los alcances (scopes) también se pueden aplicar a API específicas de fs utilizando el identificador de la API en lugar de fs:scope:

{
  "permissions": [
    {
      "identifier": "fs:allow-exists",
      "allow": [{ "path": "$APPDATA/databases/*" }]
    }
  ]
}

Nota el uso de la variable $APPDATA. El valor se inyecta en tiempo de ejecución, resolviéndose al directorio de datos de la aplicación.

Las variables disponibles son: $APPCONFIG, $APPDATA, $APPLOCALDATA, $APPCACHE, $APPLOG, $AUDIO, $CACHE, $CONFIG, $DATA, $LOCALDATA, $DESKTOP, $DOCUMENT, $DOWNLOAD, $EXE, $FONT, $HOME, $PICTURE, $PUBLIC, $RUNTIME, $TEMPLATE, $VIDEO, $RESOURCE, $TEMP.

Intentar ejecutar cualquier API con una URL no configurada en el alcance resulta en un rechazo de la promesa debido a acceso denegado.

Enumeraciones

BaseDirectory

Desde

2.0.0

Miembros de enumeraciones

AppCache

AppCache: 16;

Ver

appCacheDir para más información.

Origen: undefined

AppConfig

AppConfig: 13;

Ver

appConfigDir para más información.

Origen: undefined

AppData

AppData: 14;

Ver

appDataDir para más información.

Origen: undefined

AppLocalData

AppLocalData: 15;

Ver

appLocalDataDir para más información.

Origen: undefined

AppLog

AppLog: 17;

Ver

appLogDir para más información.

Origen: undefined

Audio

Audio: 1;

Ver

audioDir para más información.

Origen: undefined

Cache

Cache: 2;

Ver

cacheDir para más información.

Origen: undefined

Configuración (Config)

Config: 3;

Ver

configDir para más información.

Origen: undefined

Data

Data: 4;

Ver

dataDir para más información.

Origen: undefined

Escritorio

Desktop: 18;

Ver

desktopDir para más información.

Origen: undefined

Document

Document: 6;

Ver

documentDir para más información.

Origen: undefined

Download

Download: 7;

Ver

downloadDir para más información.

Origen: undefined

Executable

Executable: 19;

Ver

executableDir para más información.

Origen: undefined

Font

Font: 20;

Ver

fontDir para más información.

Origen: undefined

Home

Home: 21;

Ver

homeDir para más información.

Origen: undefined

LocalData

LocalData: 5;

Ver

localDataDir para más información.

Origen: undefined

Picture

Picture: 8;

Ver

pictureDir para más información.

Origen: undefined

Public

Public: 9;

Ver

publicDir para más información.

Origen: undefined

Resource

Resource: 11;

Ver

resourceDir para más información.

Origen: undefined

Runtime

Runtime: 22;

Ver

runtimeDir para más información.

Origen: undefined

Temp

Temp: 12;

Ver

tempDir para más información.

Origen: undefined

Template

Template: 23;

Ver

templateDir para más información.

Origen: undefined

Video

Video: 10;

Ver

videoDir para más información.

Origen: undefined

---

SeekMode

Miembros de enumeraciones

Current

Current: 1;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L93

End

End: 2;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L94

Start

Start: 0;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L92

Clases

FileHandle

La abstracción de Tauri para leer y escribir archivos.

Desde

2.0.0

Extiende

• Resource

Constructores

new FileHandle()

new FileHandle(rid): FileHandle

Parámetros

Parámetro	Tipo
rid	number

Devuelve

FileHandle

Heredado de

Resource.constructor

Origen: undefined

Accesores

rid

get rid(): number

Devuelve

number

Heredado de

Resource.rid

Origen: undefined

Métodos

close()

close(): Promise<void>

Destruye y limpia este recurso de la memoria. Ya no deberías llamar a ningún método de este objeto y deberías descartar cualquier referencia a él.

Devuelve

Promise<void>

Heredado de

Resource.close

Origen: undefined

read()

read(buffer): Promise<null | number>

Lee hasta p.byteLength bytes en p. Se resuelve al número de bytes leídos (0 < n <= p.byteLength) y se rechaza si se encuentra algún error. Incluso si read() se resuelve a n < p.byteLength, puede usar todo p como espacio de trabajo temporal durante la llamada. Si hay algunos datos disponibles pero no p.byteLength bytes, read() convencionalmente se resuelve a lo que está disponible en lugar de esperar por más.

Cuando read() encuentra una condición de fin de archivo (EOF), se resuelve a EOF (null).

Cuando read() encuentra un error, se rechaza con un error.

Quienes llamen a esta función siempre deben procesar los n > 0 bytes devueltos antes de considerar el EOF (null). Hacerlo maneja correctamente los errores de E/S que ocurren después de leer algunos bytes y también ambos comportamientos de EOF permitidos.

Parámetros

Parámetro	Tipo
buffer	Uint8Array

Devuelve

Promise<null | number>

Ejemplo

import { open, BaseDirectory } from "@tauri-apps/plugin-fs"
// if "$APPCONFIG/foo/bar.txt" contains the text "hello world":
const file = await open("foo/bar.txt", { baseDir: BaseDirectory.AppConfig });
const buf = new Uint8Array(100);
const numberOfBytesRead = await file.read(buf); // 11 bytes
const text = new TextDecoder().decode(buf);  // "hello world"
await file.close();

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L327

seek()

seek(offset, whence): Promise<number>

Seek establece el desplazamiento para el siguiente read() o write() a offset, interpretado según whence: Start significa relativo al inicio del archivo, Current significa relativo al desplazamiento actual, y End significa relativo al final. Seek se resuelve al nuevo desplazamiento relativo al inicio del archivo.

Buscar (seek) hacia un desplazamiento antes del inicio del archivo es un error. Buscar a cualquier desplazamiento positivo es legal, pero el comportamiento de operaciones de E/S subsiguientes en el objeto subyacente depende de la implementación. Devuelve el número de la posición del cursor.

Parámetros

Parámetro	Tipo
offset	number
whence	SeekMode

Devuelve

Promise<number>

Ejemplo

import { open, SeekMode, BaseDirectory } from '@tauri-apps/plugin-fs';

// Given hello.txt pointing to file with "Hello world", which is 11 bytes long:
const file = await open('hello.txt', { read: true, write: true, truncate: true, create: true, baseDir: BaseDirectory.AppLocalData });
await file.write(new TextEncoder().encode("Hello world"));

// Seek 6 bytes from the start of the file
console.log(await file.seek(6, SeekMode.Start)); // "6"
// Seek 2 more bytes from the current position
console.log(await file.seek(2, SeekMode.Current)); // "8"
// Seek backwards 2 bytes from the end of the file
console.log(await file.seek(-2, SeekMode.End)); // "9" (e.g. 11-2)

await file.close();

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L382

stat()

stat(): Promise<FileInfo>

Devuelve un FileInfo para este archivo.

Devuelve

Promise<FileInfo>

Ejemplo

import { open, BaseDirectory } from '@tauri-apps/plugin-fs';
const file = await open("file.txt", { read: true, baseDir: BaseDirectory.AppLocalData });
const fileInfo = await file.stat();
console.log(fileInfo.isFile); // true
await file.close();

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L404

truncate()

truncate(len?): Promise<void>

Trunca o extiende este archivo para alcanzar el len especificado. Si no se especifica len, se trunca todo el contenido del archivo.

Parámetros

Parámetro	Tipo
len?	number

Devuelve

Promise<void>

Ejemplo

import { open, BaseDirectory } from '@tauri-apps/plugin-fs';

// truncate the entire file
const file = await open("my_file.txt", { read: true, write: true, create: true, baseDir: BaseDirectory.AppLocalData });
await file.truncate();

// truncate part of the file
const file = await open("my_file.txt", { read: true, write: true, create: true, baseDir: BaseDirectory.AppLocalData });
await file.write(new TextEncoder().encode("Hello World"));
await file.truncate(7);
const data = new Uint8Array(32);
await file.read(data);
console.log(new TextDecoder().decode(data)); // Hello W
await file.close();

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L436

write()

write(data): Promise<number>

Escribe data.byteLength bytes desde data en el flujo de datos subyacente. Se resuelve al número de bytes escritos desde data (0 <= n <= data.byteLength) o se rechaza con el error encontrado que causó que la escritura se detuviera antes de tiempo. write() debe rechazarse con un error no nulo si se resolviera a n < data.byteLength. write() no debe modificar los datos del slice, ni siquiera temporalmente.

Parámetros

Parámetro	Tipo
data	Uint8Array

Devuelve

Promise<number>

Ejemplo

import { open, write, BaseDirectory } from '@tauri-apps/plugin-fs';
const encoder = new TextEncoder();
const data = encoder.encode("Hello world");
const file = await open("bar.txt", { write: true, baseDir: BaseDirectory.AppLocalData });
const bytesWritten = await file.write(data); // 11
await file.close();

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L463

Interfaces

CopyFileOptions

Desde

2.0.0

Propiedades

Propiedad	Tipo	Descripción	Definido en
fromPathBaseDir?	BaseDirectory	Directorio base para fromPath.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L599
toPathBaseDir?	BaseDirectory	Directorio base para toPath.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L601

---

CreateOptions

Desde

2.0.0

Propiedades

Propiedad	Tipo	Descripción	Definido en
baseDir?	BaseDirectory	Directorio base para path	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L476

---

DebouncedWatchOptions

Desde

2.0.0

Extiende

• WatchOptions

Propiedades

Propiedad	Tipo	Descripción	Heredado de	Definido en
baseDir?	BaseDirectory	Directorio base para path	WatchOptions.baseDir	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1195
delayMs?	number	Retardo de debounce	-	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1203
recursive?	boolean	Observar un directorio de forma recursiva	WatchOptions.recursive	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1193

---

DirEntry

Una entrada de disco que es un archivo, un directorio o un symlink.

Este es el resultado de la función readDir.

Desde

2.0.0

Propiedades

Propiedad	Tipo	Descripción	Definido en
isDirectory	boolean	Especifica si esta entrada es un directorio o no.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L690
isFile	boolean	Especifica si esta entrada es un archivo o no.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L692
isSymlink	boolean	Especifica si esta entrada es un symlink o no.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L694
name	string	El nombre de la entrada (nombre de archivo con extensión o nombre de directorio).	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L688

---

ExistsOptions

Desde

2.0.0

Propiedades

Propiedad	Tipo	Descripción	Definido en
baseDir?	BaseDirectory	Directorio base para path.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1160

---

FileInfo

Un FileInfo describe un archivo y es devuelto por stat, lstat o fstat.

Desde

2.0.0

Propiedades

Propiedad	Tipo	Descripción	Definido en
atime	null | Date	La hora de último acceso del archivo. Esto corresponde al campo atime de stat en Unix y a ftLastAccessTime en Windows. Es posible que no esté disponible en todas las plataformas.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L133
birthtime	null | Date	La hora de creación del archivo. Esto corresponde al campo birthtime de stat en Mac/BSD y a ftCreationTime en Windows. Es posible que no esté disponible en todas las plataformas.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L139
blksize	null | number	Tamaño de bloque para la E/S del sistema de archivos. Específico de la plataforma - Windows: No soportado.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L216
blocks	null | number	Número de bloques asignados al archivo, en unidades de 512 bytes. Específico de la plataforma - Windows: No soportado.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L224
dev	null | number	ID del dispositivo que contiene el archivo. Específico de la plataforma - Windows: No soportado.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L159
fileAttributes	null | number	Este campo contiene la información de atributos del sistema de archivos para un archivo o directorio. Para posibles valores y sus descripciones, consulta Constantes de Atributos de Archivo en el Dev Center de Windows. Específico de la plataforma - macOS / Linux / Android / iOS: No soportado.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L151
gid	null | number	ID del grupo propietario de este archivo. Específico de la plataforma - Windows: No soportado.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L200
ino	null | number	Número de Inode. Específico de la plataforma - Windows: No soportado.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L167
isDirectory	boolean	Verdadero si esta información corresponde a un directorio regular. Mutuamente excluyente con FileInfo.isFile y FileInfo.isSymlink.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L112
isFile	boolean	Verdadero si esta información corresponde a un archivo regular. Mutuamente excluyente con FileInfo.isDirectory y FileInfo.isSymlink.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L107
isSymlink	boolean	Verdadero si esta información corresponde a un symlink. Mutuamente excluyente con FileInfo.isFile y FileInfo.isDirectory.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L117
mode	null | number	Los bits raw de st_mode subyacentes que contienen los permisos estándar de Unix para este archivo/directorio. Específico de la plataforma - Windows: No soportado.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L176
mtime	null | Date	La última hora de modificación del archivo. Esto corresponde al campo mtime de stat en Linux/macOS y a ftLastWriteTime en Windows. Es posible que no esté disponible en todas las plataformas.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L127
nlink	null | number	Número de enlaces duros (hard links) que apuntan a este archivo. Específico de la plataforma - Windows: No soportado.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L184
rdev	null | number	ID del dispositivo de este archivo. Específico de la plataforma - Windows: No soportado.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L208
readonly	boolean	Si este es un archivo de solo lectura (no escribible).	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L141
size	number	El tamaño del archivo, en bytes.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L121
uid	null | number	ID de usuario del propietario de este archivo. Específico de la plataforma - Windows: No soportado.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L192

---

MkdirOptions

Desde

2.0.0

Propiedades

Propiedad	Tipo	Descripción	Definido en
baseDir?	BaseDirectory	Directorio base para path	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L644
mode?	number	Permisos que se utilizarán al crear el directorio (por defecto es 0o777, antes del umask del proceso). Ignorado en Windows.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L638
recursive?	boolean	Por defecto es false. Si se establece en true, significa que también se crearán los directorios intermedios (como ocurre con el comando de shell mkdir -p).	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L642

---

OpenOptions

Desde

2.0.0

Propiedades

Propiedad	Tipo	Descripción	Definido en
append?	boolean	Establece la opción para el modo de anexado (append). Esta opción, cuando es true, significa que las escrituras se anexarán al archivo en lugar de sobrescribir el contenido anterior. Ten en cuenta que establecer { write: true, append: true } tiene el mismo efecto que establecer únicamente { append: true }.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L531
baseDir?	BaseDirectory	Directorio base para path	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L559
create?	boolean	Establece la opción para permitir crear un nuevo archivo, si no existe uno en la ruta especificada. Requiere el uso de acceso de escritura o anexado (append).	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L544
createNew?	boolean	Por defecto es false. Si se establece en true, no se permite que exista ningún archivo, directorio o symlink en la ubicación de destino. Requiere el uso de acceso de escritura o anexado. Cuando createNew se establece en true, create y truncate se ignoran.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L551
mode?	number	Permisos que se utilizarán al crear el archivo (por defecto es 0o666, antes del umask del proceso). Ignorado en Windows.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L557
read?	boolean	Establece la opción para el acceso de lectura. Esta opción, cuando es true, significa que el archivo se podrá leer si se abre.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L517
truncate?	boolean	Establece la opción para truncar un archivo previo. Si un archivo se abre exitosamente con esta opción establecida, truncará el archivo a tamaño 0 si ya existe. El archivo se debe abrir con acceso de escritura para que truncar funcione.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L538
write?	boolean	Establece la opción para el acceso de escritura. Esta opción, cuando es true, significa que el archivo se podrá escribir si se abre. Si el archivo ya existe, cualquier llamada de escritura en él sobrescribirá su contenido, por defecto sin truncarlo.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L524

---

ReadDirOptions

Desde

2.0.0

Propiedades

Propiedad	Tipo	Descripción	Definido en
baseDir?	BaseDirectory	Directorio base para path	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L676

---

ReadFileOptions

Desde

2.0.0

Propiedades

Propiedad	Tipo	Descripción	Definido en
baseDir?	BaseDirectory	Directorio base para path	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L738
encoding?	string	Codificación de texto a usar al leer un archivo de texto. Por defecto es 'utf-8'.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L740

---

RemoveOptions

Desde

2.0.0

Propiedades

Propiedad	Tipo	Descripción	Definido en
baseDir?	BaseDirectory	Directorio base para path	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L882
recursive?	boolean	Por defecto es false. Si se establece en true, la ruta se eliminará incluso si es un directorio no vacío.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L880

---

RenameOptions

Desde

2.0.0

Propiedades

Propiedad	Tipo	Descripción	Definido en
newPathBaseDir?	BaseDirectory	Directorio base para newPath.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L918
oldPathBaseDir?	BaseDirectory	Directorio base para oldPath.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L916

---

StatOptions

Desde

2.0.0

Propiedades

Propiedad	Tipo	Descripción	Definido en
baseDir?	BaseDirectory	Directorio base para path.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L960

---

TruncateOptions

Desde

2.0.0

Propiedades

Propiedad	Tipo	Descripción	Definido en
baseDir?	BaseDirectory	Directorio base para path.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1019

---

WatchEvent

Desde

2.0.0

Propiedades

Propiedad	Tipo	Definido en
attrs	unknown	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1212
paths	string[]	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1211
type	WatchEventKind	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1210

---

WatchOptions

Desde

2.0.0

Extendido por

• DebouncedWatchOptions

Propiedades

Propiedad	Tipo	Descripción	Definido en
baseDir?	BaseDirectory	Directorio base para path	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1195
recursive?	boolean	Observar un directorio de forma recursiva	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1193

---

WriteFileOptions

Desde

2.0.0

Propiedades

Propiedad	Tipo	Descripción	Definido en
append?	boolean	Por defecto es false. Si se establece en true, se anexará al archivo en lugar de sobrescribir el contenido anterior.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1063
baseDir?	BaseDirectory	Directorio base para path	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1071
create?	boolean	Establece la opción para permitir crear un nuevo archivo, si no existe uno en la ruta especificada (por defecto es true).	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1065
createNew?	boolean	Establece la opción para crear un nuevo archivo, fallando si ya existe.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1067
mode?	number	Permisos de archivo. Ignorado en Windows.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1069

Alias de tipos

UnwatchFn()

type UnwatchFn: () => void;

Devuelve

void

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1277

---

WatchEventKind

type WatchEventKind:
  | "any"
  | object
  | object
  | object
  | object
  | "other";

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1218

---

WatchEventKindAccess

type WatchEventKindAccess: object | object | object | object;

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1229

---

WatchEventKindCreate

type WatchEventKindCreate: object | object | object | object;

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1238

---

WatchEventKindModify

type WatchEventKindModify:
  | object
  | object
  | object
  | object
  | object;

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1247

---

WatchEventKindRemove

type WatchEventKindRemove: object | object | object | object;

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1267

Funciones

copyFile()

function copyFile(
   fromPath,
   toPath,
options?): Promise<void>

Copia el contenido y los permisos de un archivo a otra ruta especificada, creando por defecto un nuevo archivo si es necesario, o sobrescribiéndolo.

Parámetros

Parámetro	Tipo
fromPath	string | URL
toPath	string | URL
options?	CopyFileOptions

Devuelve

Promise<void>

Ejemplo

import { copyFile, BaseDirectory } from '@tauri-apps/plugin-fs';
await copyFile('app.conf', 'app.conf.bk', { fromPathBaseDir: BaseDirectory.AppConfig, toPathBaseDir: BaseDirectory.AppConfig });

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L614

---

create()

function create(path, options?): Promise<FileHandle>

Crea un archivo si no existe ninguno o trunca un archivo existente y se resuelve a una instancia de FileHandle.

Parámetros

Parámetro	Tipo
path	string | URL
options?	CreateOptions

Devuelve

Promise<FileHandle>

Ejemplo

import { create, BaseDirectory } from "@tauri-apps/plugin-fs"
const file = await create("foo/bar.txt", { baseDir: BaseDirectory.AppConfig });
await file.write(new TextEncoder().encode("Hello world"));
await file.close();

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L493

---

exists()

function exists(path, options?): Promise<boolean>

Comprueba si existe una ruta.

Parámetros

Parámetro	Tipo
path	string | URL
options?	ExistsOptions

Devuelve

Promise<boolean>

Ejemplo

import { exists, BaseDirectory } from '@tauri-apps/plugin-fs';
// Check if the `$APPDATA/avatar.png` file exists
await exists('avatar.png', { baseDir: BaseDirectory.AppData });

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1174

---

lstat()

function lstat(path, options?): Promise<FileInfo>

Se resuelve a un FileInfo para la ruta path especificada. Si path es un symlink, se devolverá la información del symlink en lugar de lo que apunta.

Parámetros

Parámetro	Tipo
path	string | URL
options?	StatOptions

Devuelve

Promise<FileInfo>

Ejemplo

import { lstat, BaseDirectory } from '@tauri-apps/plugin-fs';
const fileInfo = await lstat("hello.txt", { baseDir: BaseDirectory.AppLocalData });
console.log(fileInfo.isFile); // true

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1002

---

mkdir()

function mkdir(path, options?): Promise<void>

Crea un nuevo directorio con la ruta especificada.

Parámetros

Parámetro	Tipo
path	string | URL
options?	MkdirOptions

Devuelve

Promise<void>

Ejemplo

import { mkdir, BaseDirectory } from '@tauri-apps/plugin-fs';
await mkdir('users', { baseDir: BaseDirectory.AppLocalData });

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L657

---

open()

function open(path, options?): Promise<FileHandle>

Abre un archivo y se resuelve a una instancia de FileHandle. El archivo no necesita existir previamente si se utilizan las opciones de apertura create o createNew. Es responsabilidad de quien llama cerrar el archivo cuando haya terminado con él.

Parámetros

Parámetro	Tipo
path	string | URL
options?	OpenOptions

Devuelve

Promise<FileHandle>

Ejemplo

import { open, BaseDirectory } from "@tauri-apps/plugin-fs"
const file = await open("foo/bar.txt", { read: true, write: true, baseDir: BaseDirectory.AppLocalData });
// Do work with file
await file.close();

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L578

---

readDir()

function readDir(path, options?): Promise<DirEntry[]>

Lee el directorio dado por la ruta y devuelve un array de DirEntry.

Parámetros

Parámetro	Tipo
path	string | URL
options?	ReadDirOptions

Devuelve

Promise<DirEntry[]>

Ejemplo

import { readDir, BaseDirectory } from '@tauri-apps/plugin-fs';
import { join } from '@tauri-apps/api/path';
const dir = "users"
const entries = await readDir('users', { baseDir: BaseDirectory.AppLocalData });
processEntriesRecursively(dir, entries);
async function processEntriesRecursively(parent, entries) {
  for (const entry of entries) {
    console.log(`Entry: ${entry.name}`);
    if (entry.isDirectory) {
       const dir = await join(parent, entry.name);
      processEntriesRecursively(dir, await readDir(dir, { baseDir: BaseDirectory.AppLocalData }))
    }
  }
}

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L719

---

readFile()

function readFile(path, options?): Promise<Uint8Array>

Lee y se resuelve a todo el contenido de un archivo como un array de bytes. Se puede usar TextDecoder para transformar los bytes a cadena de texto (string) si es necesario.

Parámetros

Parámetro	Tipo
path	string | URL
options?	ReadFileOptions

Devuelve

Promise<Uint8Array>

Ejemplo

import { readFile, BaseDirectory } from '@tauri-apps/plugin-fs';
const contents = await readFile('avatar.png', { baseDir: BaseDirectory.Resource });

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L754

---

readTextFile()

function readTextFile(path, options?): Promise<string>

Lee y devuelve todo el contenido de un archivo como una cadena de texto (string) utilizando la codificación especificada (por defecto: UTF-8).

Parámetros

Parámetro	Tipo
path	string | URL
options?	ReadFileOptions

Devuelve

Promise<string>

Ejemplo

import { readTextFile, BaseDirectory } from '@tauri-apps/plugin-fs';
const contents = await readTextFile('app.conf', { baseDir: BaseDirectory.AppConfig });

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L780

---

readTextFileLines()

function readTextFileLines(path, options?): Promise<AsyncIterableIterator<string>>

Devuelve un AsyncIterableIterator asíncrono sobre las líneas de un archivo, decodificado usando la codificación especificada (por defecto: UTF-8).

Parámetros

Parámetro	Tipo
path	string | URL
options?	ReadFileOptions

Devuelve

Promise<AsyncIterableIterator<string>>

Ejemplo

import { readTextFileLines, BaseDirectory } from '@tauri-apps/plugin-fs';
const lines = await readTextFileLines('app.conf', { baseDir: BaseDirectory.AppConfig });
for await (const line of lines) {
  console.log(line);
}

También podrías llamar a AsyncIterableIterator.next para hacer avanzar el iterador y así poder leer de forma perezosa (lazy) la siguiente línea cuando quieras.

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L813

---

remove()

function remove(path, options?): Promise<void>

Elimina el archivo o directorio nombrado. Si el directorio no está vacío y la opción recursive no se establece en true, se rechazará la promesa.

Parámetros

Parámetro	Tipo
path	string | URL
options?	RemoveOptions

Devuelve

Promise<void>

Ejemplo

import { remove, BaseDirectory } from '@tauri-apps/plugin-fs';
await remove('users/file.txt', { baseDir: BaseDirectory.AppLocalData });
await remove('users', { baseDir: BaseDirectory.AppLocalData });

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L897

---

rename()

function rename(
   oldPath,
   newPath,
options?): Promise<void>

Renombra (mueve) oldpath a newpath. Las rutas pueden ser archivos o directorios. Si newpath ya existe y no es un directorio, rename() lo reemplaza. Pueden aplicarse restricciones específicas del sistema operativo cuando oldpath y newpath están en directorios diferentes.

En Unix, esta operación no sigue enlaces simbólicos (symlinks) en ninguna de las dos rutas.

Parámetros

Parámetro	Tipo
oldPath	string | URL
newPath	string | URL
options?	RenameOptions

Devuelve

Promise<void>

Ejemplo

import { rename, BaseDirectory } from '@tauri-apps/plugin-fs';
await rename('avatar.png', 'deleted.png', { oldPathBaseDir: BaseDirectory.App, newPathBaseDir: BaseDirectory.AppLocalData });

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L936

---

size()

function size(path): Promise<number>

Obtiene el tamaño de un archivo o directorio. Para archivos, también se pueden utilizar las funciones stat.

Si path es un directorio, esta función iterará recursivamente sobre cada archivo y cada directorio dentro de path y, por lo tanto, consumirá mucho tiempo si se usa en directorios más grandes.

Parámetros

Parámetro	Tipo
path	string | URL

Devuelve

Promise<number>

Ejemplo

import { size, BaseDirectory } from '@tauri-apps/plugin-fs';
// Get the size of the `$APPDATA/tauri` directory.
const dirSize = await size('tauri', { baseDir: BaseDirectory.AppData });
console.log(dirSize); // 1024

Desde

2.1.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1359

---

startAccessingSecurityScopedResource()

function startAccessingSecurityScopedResource(path): Promise<void>

Inicia el acceso a un recurso con alcance de seguridad para la URL de archivo dada. Se debe llamar a esto cuando estés accediendo a un archivo que fue abierto usando una URL con alcance de seguridad (por ejemplo, desde un selector de archivos).

Ten en cuenta que el acceso a recursos con alcance de seguridad es gestionado automáticamente por el plugin en iOS, por lo que no necesitas llamar a esta función a menos que quieras gestionar el alcance manualmente.

Debes llamar a stopAccessingSecurityScopedResource cuando hayas terminado de acceder al recurso.

Específico de la plataforma

• iOS: Inicia el acceso al recurso con alcance de seguridad.
• Otras plataformas: no hace nada.

Parámetros

Parámetro	Tipo
path	string | URL

Devuelve

Promise<void>

Ejemplo

import { startAccessingSecurityScopedResource } from '@tauri-apps/plugin-fs';

const filePath = 'file:///path/to/file.txt';
await startAccessingSecurityScopedResource(filePath);
// ... use the resource ...

Desde

2.5.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1395

---

stat()

function stat(path, options?): Promise<FileInfo>

Se resuelve a un FileInfo para la ruta path especificada. Siempre seguirá los symlinks pero se rechazará si el symlink apunta a una ruta fuera del alcance.

Parámetros

Parámetro	Tipo
path	string | URL
options?	StatOptions

Devuelve

Promise<FileInfo>

Ejemplo

import { stat, BaseDirectory } from '@tauri-apps/plugin-fs';
const fileInfo = await stat("hello.txt", { baseDir: BaseDirectory.AppLocalData });
console.log(fileInfo.isFile); // true

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L976

---

stopAccessingSecurityScopedResource()

function stopAccessingSecurityScopedResource(path): Promise<void>

Detiene el acceso a un recurso con alcance de seguridad para la URL de archivo dada. Se debe llamar a esto cuando hayas terminado de acceder a un archivo abierto usando una URL con alcance de seguridad (por ejemplo, desde un selector de archivos) cuando se usa seguimiento manual mediante startAccessingSecurityScopedResource.

Específico de la plataforma

• iOS: Detiene el acceso al recurso con alcance de seguridad.
• Otras plataformas: no hace nada.

Parámetros

Parámetro	Tipo
path	string | URL

Devuelve

Promise<void>

Ejemplo

import { stopAccessingSecurityScopedResource } from '@tauri-apps/plugin-fs';

const filePath = 'file:///path/to/file.txt';
await startAccessingSecurityScopedResource(filePath);
// ... use the resource ...
// when you're done with the resource:
await stopAccessingSecurityScopedResource(filePath);

Desde

2.5.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1430

---

truncate()

function truncate(
   path,
   len?,
options?): Promise<void>

Trunca o extiende el archivo especificado para alcanzar el len especificado. Si len es 0 o no se especifica, se trunca todo el contenido del archivo.

Parámetros

Parámetro	Tipo
path	string | URL
len?	number
options?	TruncateOptions

Devuelve

Promise<void>

Ejemplo

import { truncate, readTextFile, writeTextFile, BaseDirectory } from '@tauri-apps/plugin-fs';
// truncate the entire file
await truncate("my_file.txt", 0, { baseDir: BaseDirectory.AppLocalData });

// truncate part of the file
const filePath = "file.txt";
await writeTextFile(filePath, "Hello World", { baseDir: BaseDirectory.AppLocalData });
await truncate(filePath, 7, { baseDir: BaseDirectory.AppLocalData });
const data = await readTextFile(filePath, { baseDir: BaseDirectory.AppLocalData });
console.log(data);  // "Hello W"

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1042

---

watch()

function watch(
   paths,
   cb,
options?): Promise<UnwatchFn>

Observa cambios (tras un retardo) en archivos o directorios.

Parámetros

Parámetro	Tipo
paths	string | URL | string[] | URL[]
cb	(event) => void
options?	DebouncedWatchOptions

Devuelve

Promise<UnwatchFn>

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1316

---

watchImmediate()

function watchImmediate(
   paths,
   cb,
options?): Promise<UnwatchFn>

Observa cambios en archivos o directorios.

Parámetros

Parámetro	Tipo
paths	string | URL | string[] | URL[]
cb	(event) => void
options?	WatchOptions

Devuelve

Promise<UnwatchFn>

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1333

---

writeFile()

function writeFile(
   path,
   data,
options?): Promise<void>

Escribe data en la ruta path dada, creando por defecto un nuevo archivo si es necesario, o sobrescribiéndolo.

Parámetros

Parámetro	Tipo
path	string | URL
data	Uint8Array | ReadableStream<Uint8Array>
options?	WriteFileOptions

Devuelve

Promise<void>

Ejemplo

import { writeFile, BaseDirectory } from '@tauri-apps/plugin-fs';

let encoder = new TextEncoder();
let data = encoder.encode("Hello World");
await writeFile('file.txt', data, { baseDir: BaseDirectory.AppLocalData });

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1087

---

writeTextFile()

function writeTextFile(
   path,
   data,
options?): Promise<void>

Escribe la cadena UTF-8 data en la ruta path dada, creando por defecto un nuevo archivo si es necesario, o sobrescribiéndolo.

Parámetros

Parámetro	Tipo
path	string | URL
data	string
options?	WriteFileOptions

Devuelve

Promise<void>

Ejemplo

import { writeTextFile, BaseDirectory } from '@tauri-apps/plugin-fs';

await writeTextFile('file.txt', "Hello world", { baseDir: BaseDirectory.AppLocalData });

Desde

2.0.0

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/guest-js/index.ts#L1136