Inicio

Instalar

bun add @capgo/capacitor-file
bunx cap sync

Importar

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

API Resumen

requestFileSystem

Solicitar un sistema de archivos.

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

await CapacitorFile.requestFileSystem({} as RequestFileSystemOptions);

resolveLocalFileSystemURL

Resolver una URL de archivo a una entrada.

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

await CapacitorFile.resolveLocalFileSystemURL({} as ResolveURLOptions);

getFile

Obtener una entrada de archivo.

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

await CapacitorFile.getFile({} as GetFileOptions);

getDirectory

Obtenga una entrada de directorio.

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

await CapacitorFile.getDirectory({} as GetDirectoryOptions);

readFile

Lea un archivo como texto o base64.

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

await CapacitorFile.readFile({} as ReadFileOptions);

readAsDataURL

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

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

await CapacitorFile.readAsDataURL({} as ReadFileOptions);

writeFile

Escriba datos en un archivo.

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

await CapacitorFile.writeFile({} as WriteFileOptions);

appendFile

Agregar datos a un archivo.

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

await CapacitorFile.appendFile({} as WriteFileOptions);

deleteFile

Eliminar un archivo.

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

await CapacitorFile.deleteFile({} as DeleteFileOptions);

mkdir

Crear un directorio.

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

await CapacitorFile.mkdir({} as MkdirOptions);

rmdir

Eliminar un directorio.

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

await CapacitorFile.rmdir({} as DeleteDirectoryOptions);

readdir

Contenido de directorio.

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

await CapacitorFile.readdir({} as ReaddirOptions);

stat

Obtener metadatos sobre un archivo o directorio.

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

await CapacitorFile.stat({} as StatOptions);

getMetadata

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

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

await CapacitorFile.getMetadata({} as StatOptions);

rename

Renombrar o mover un archivo o directorio.

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

await CapacitorFile.rename({} as RenameOptions);

move

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

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

await CapacitorFile.move({} as RenameOptions);

copy

Copiar un archivo o directorio.

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

await CapacitorFile.copy({} as CopyOptions);

exists

Comprobar si un archivo o directorio existe.

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

await CapacitorFile.exists({} as ExistsOptions);

getUri

Obtener la URI para un archivo.

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

await CapacitorFile.getUri({} as GetUriOptions);

truncate

Truncar un archivo a un tamaño especificado.

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

await CapacitorFile.truncate({} as TruncateOptions);

getDirectories

Obtener todos los directorios conocidos del sistema de archivos.

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

await CapacitorFile.getDirectories();

getFreeDiskSpace

Obtener el espacio libre en disco en bytes.

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

await CapacitorFile.getFreeDiskSpace();

checkPermissions

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

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

await CapacitorFile.checkPermissions();

requestPermissions

Solicite permisos para operaciones de archivo. En Android, esto solicita permisos de almacenamiento externo necesarios para acceder a archivos fuera de los directorios privados de la aplicación. En iOS y web, esto siempre devuelve ‘concedido’ ya que no se necesitan permisos especiales.

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

await CapacitorFile.requestPermissions();

Referencia de tipo

RequestFileSystemOptions

Opciones para solicitar un sistema de archivos.

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

Representa un sistema de archivos.

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 un archivo o directorio de entrada.

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.tsRe-ejecutar la sincronización cuando el público API cambie en la fuente.

Seguir desde Inicio

Si estás utilizando Inicio para planificar el almacenamiento y el manejo de archivos, conecte 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.