Getting Started

Instalar

Puede utilizar nuestra configuración asistida por IA para instalar el complemento. Agregue las Capgo habilidades a su herramienta de IA utilizando el siguiente comando:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Luego utilice la siguiente solicitud:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-file` plugin in my project.

Si prefieres la configuración manual, instala el complemento ejecutando los siguientes comandos y sigue las instrucciones específicas de la plataforma a continuación.

bun add @capgo/capacitor-file
bunx cap sync

Import

import { CapacitorFile } from '@capgo/capacitor-file';

API Resumen

requestFileSystem

Solicitar un sistema de archivos.

import { CapacitorFile, FileSystemType } from '@capgo/capacitor-file';

const result = await CapacitorFile.requestFileSystem({ type: FileSystemType.TEMPORARY });
console.log(result);

resolveLocalFileSystemURL

Resolver una URL de archivo a una entrada.

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.resolveLocalFileSystemURL({ url: 'https://example.com' });
console.log(result);

getFile

Obtener una entrada de archivo.

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.getFile({ path: 'path/to/file' });
console.log(result);

getDirectory

Obtén una entrada de directorio.

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.getDirectory({ path: 'path/to/file' });
console.log(result);

readFile

Lee un archivo como texto o base64.

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.readFile({ path: 'path/to/file' });
console.log(result);

readAsDataURL

Lee un archivo como una URL de datos (base64 con prefijo MIME).

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.readAsDataURL({ path: 'path/to/file' });
console.log(result);

writeFile

Escribe datos en un archivo.

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.writeFile({
  path: 'path/to/file',
  data: 'data',
});
console.log(result);

appendFile

Agregar datos a un archivo.

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.appendFile({
  path: 'path/to/file',
  data: 'data',
});
console.log(result);

deleteFile

Borrar un archivo.

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.deleteFile({ path: 'path/to/file' });

mkdir

Crear un directorio.

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.mkdir({ path: 'path/to/file' });

rmdir

Borrar un directorio.

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.rmdir({ path: 'path/to/file' });

readdir

Leer los contenidos del directorio.

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.readdir({ path: 'path/to/file' });
console.log(result);

stat

Obtener metadatos sobre un archivo o directorio.

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.stat({ path: 'path/to/file' });
console.log(result);

getMetadata

Obtener metadatos sobre un archivo o directorio. Alias para stat().

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.getMetadata({ path: 'path/to/file' });
console.log(result);

rename

Renombrar o mover un archivo o directorio.

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.rename({
  from: 'from',
  to: 'to',
});

move

Mueva un archivo o directorio. Alias para rename().

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.move({
  from: 'from',
  to: 'to',
});

copy

Copiar un archivo o directorio.

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.copy({
  from: 'from',
  to: 'to',
});
console.log(result);

exists

Verificar si un archivo o directorio existe.

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.exists({ path: 'path/to/file' });
console.log(result);

getUri

Obtener la URI para un archivo.

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.getUri({ path: 'path/to/file' });
console.log(result);

truncate

Truncar un archivo a un tamaño especificado.

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.truncate({ path: 'path/to/file' });

getDirectories

Get all known file system directories.

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.getDirectories();
console.log(result);

getFreeDiskSpace

Obtener el espacio libre en disco en bytes.

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.getFreeDiskSpace();
console.log(result);

checkPermissions

Comprobar el estado de permisos actual para operaciones de archivo. En Android, esto verifica las permisos de almacenamiento externo. En iOS y web, siempre devuelve ‘concedido’ ya que no se necesitan permisos especiales.

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.checkPermissions();
console.log(result);

requestPermissions

Permisos para operaciones de archivo. En Android, solicita permisos de almacenamiento externo necesarios para acceder a archivos fuera de los directorios privados del aplicativo. En iOS y web, siempre devuelve ‘concedido’ ya que no se necesitan permisos especiales.

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.requestPermissions();
console.log(result);

Referencia de tipo

RequestFileSystemOptions

Sección titulada “FileSystem”

export interface RequestFileSystemOptions {
  /** The type of file system to request */
  type: FileSystemType;
  /** Requested size in bytes (may not be enforced on all platforms) */
  size?: number;
}

FileSystem

Sección titulada “ResolveURLOptions”

export interface FileSystem {
  /** The name of the file system */
  name: string;
  /** The root directory of the file system */
  root: DirectoryEntry;
}

ResolveURLOptions

Opciones para resolver una URL a una entrada.

export interface ResolveURLOptions {
  /** The URL to resolve (file:// or cdvfile://) */
  url: string;
}

Entry

Representa una entrada de archivo o directorio.

export interface Entry {
  /** True if this is a file */
  isFile: boolean;
  /** True if this is a directory */
  isDirectory: boolean;
  /** The name of the file or directory */
  name: string;
  /** The full path relative to the filesystem root */
  fullPath: string;
  /** The native file:// URI */
  nativeURL: string;
}

GetFileOptions

Opciones para obtener un archivo.

export interface GetFileOptions {
  /** Path to the file */
  path: string;
  /** Base directory */
  directory?: Directory;
  /** Options for creating the file */
  options?: GetOptions;
}

FileEntry

Representa una entrada de archivo.

export interface FileEntry extends Entry {
  isFile: true;
  isDirectory: false;
}

GetDirectoryOptions

Opciones para obtener un directorio.

export interface GetDirectoryOptions {
  /** Path to the directory */
  path: string;
  /** Base directory */
  directory?: Directory;
  /** Options for creating the directory */
  options?: GetOptions;
}

DirectoryEntry

Representa una entrada de directorio.

export interface DirectoryEntry extends Entry {
  isFile: false;
  isDirectory: true;
}

ReadFileOptions

Opciones para leer un archivo.

export interface ReadFileOptions {
  /** Path to the file */
  path: string;
  /** Base directory */
  directory?: Directory;
  /** Encoding for text files (omit for binary/base64) */
  encoding?: Encoding;
  /** Byte offset to start reading from (default: 0) */
  offset?: number;
  /** Number of bytes to read (default: read to end of file) */
  length?: number;
}

ReadFileResult

Resultado de leer un archivo.

export interface ReadFileResult {
  /** File contents as string (text) or base64 (binary) */
  data: string;
}

WriteFileOptions

Opciones para escribir un archivo.

export interface WriteFileOptions {
  /** Path to the file */
  path: string;
  /** Base directory */
  directory?: Directory;
  /** Data to write (string for text, base64 for binary) */
  data: string;
  /** Encoding for text files */
  encoding?: Encoding;
  /** If true, append to existing file instead of overwriting */
  append?: boolean;
  /** Create intermediate directories if they don't exist */
  recursive?: boolean;
  /** Byte position to start writing at (for random access writes). If not specified, writes from beginning or appends based on 'append' flag */
  position?: number;
}

WriteFileResult

Resultado de escribir un archivo.

export interface WriteFileResult {
  /** The URI of the written file */
  uri: string;
}

Fuente de Verdad

Esta página se genera desde el plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.

Sigue adelante desde Inicio

Si estás utilizando Getting Started para planificar el almacenamiento y el manejo de archivos, conectarlo con Usando @capgo/capacitor-archivo para la capacidad nativa en Usando @capgo/capacitor-archivo, @capgo/capacitor-almacenamiento-de-datos-sqlite para el detalle de implementación en @capgo/capacitor-almacenamiento-de-datos-sqlite, Usando @capgo/capacitor-almacenamiento-de-datos-sqlite para la capacidad nativa en Usando @capgo/capacitor-almacenamiento-de-datos-sqlite, @capgo/capacitor-archivo para el detalle de implementación en @capgo/capacitor-archivo, y @capgo/capacitor-subidor para el detalle de implementación en @capgo/capacitor-subidor.