requestFileSystem(options: RequestFileSystemOptions) => Promise<FileSystem>

resolveLocalFileSystemURL(options: ResolveURLOptions) => Promise<Entry>

getFile(options: GetFileOptions) => Promise<FileEntry>

getDirectory(options: GetDirectoryOptions) => Promise<DirectoryEntry>

readFile(options: ReadFileOptions) => Promise<ReadFileResult>

readAsDataURL(options: ReadFileOptions) => Promise<{ data: string; }>

writeFile(options: WriteFileOptions) => Promise<WriteFileResult>

appendFile(options: WriteFileOptions) => Promise<WriteFileResult>

deleteFile(options: DeleteFileOptions) => Promise<void>

mkdir(options: MkdirOptions) => Promise<void>

rmdir(options: DeleteDirectoryOptions) => Promise<void>

readdir(options: ReaddirOptions) => Promise<ReaddirResult>

stat(options: StatOptions) => Promise<StatResult>

getMetadata(options: StatOptions) => Promise<Metadata>

rename(options: RenameOptions) => Promise<void>

move(options: RenameOptions) => Promise<void>

copy(options: CopyOptions) => Promise<CopyResult>

exists(options: ExistsOptions) => Promise<ExistsResult>

getUri(options: GetUriOptions) => Promise<GetUriResult>

truncate(options: TruncateOptions) => Promise<void>

getDirectories() => Promise<FileDirectories>

getFreeDiskSpace() => Promise<{ free: number; }>

addListener(eventName: 'readProgress', listenerFunc: (progress: ProgressEvent) => void) => Promise<PluginListenerHandle>

addListener(eventName: 'writeProgress', listenerFunc: (progress: ProgressEvent) => void) => Promise<PluginListenerHandle>

removeAllListeners() => Promise<void>

getPluginVersion() => Promise<{ version: string; }>

checkPermissions() => Promise<FilePermissionStatus>

requestPermissions(options?: PermissionRequestOptions | undefined) => Promise<FilePermissionStatus>

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

// Read as text
const result = await CapacitorFile.readFile({
  path: 'my-file.txt',
  directory: Directory.Documents,
  encoding: Encoding.UTF8,
});
console.log(result.data);

// Read as base64 (binary)
const binaryResult = await CapacitorFile.readFile({
  path: 'image.png',
  directory: Directory.Documents,
});
console.log(binaryResult.data); // base64 string

// Read partial file (offset and length) - great for large files!
const partialResult = await CapacitorFile.readFile({
  path: 'large-file.bin',
  directory: Directory.Documents,
  offset: 1024,    // Start at byte 1024
  length: 512,     // Read 512 bytes
});
console.log(partialResult.data); // base64 encoded chunk

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

// Write text
await CapacitorFile.writeFile({
  path: 'my-file.txt',
  directory: Directory.Documents,
  data: 'Hello, World!',
  encoding: Encoding.UTF8,
  recursive: true, // Create parent directories if needed
});

// Write binary (base64)
await CapacitorFile.writeFile({
  path: 'image.png',
  directory: Directory.Documents,
  data: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==',
});

// Write at specific position (random access) - great for patching files!
await CapacitorFile.writeFile({
  path: 'data.bin',
  directory: Directory.Documents,
  data: 'PATCHED',
  encoding: Encoding.UTF8,
  position: 100,  // Write starting at byte 100
});

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

// Create a directory
await CapacitorFile.mkdir({
  path: 'my-folder/sub-folder',
  directory: Directory.Documents,
  recursive: true,
});

// Read directory contents
const result = await CapacitorFile.readdir({
  path: 'my-folder',
  directory: Directory.Documents,
});

for (const entry of result.entries) {
  console.log(`${entry.name} - ${entry.isFile ? 'file' : 'directory'}`);
}

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

// Copy a file
await CapacitorFile.copy({
  from: 'original.txt',
  to: 'backup/original-copy.txt',
  directory: Directory.Documents,
  toDirectory: Directory.Documents,
});

// Move/rename a file
await CapacitorFile.rename({
  from: 'old-name.txt',
  to: 'new-name.txt',
  directory: Directory.Documents,
});

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

const result = await CapacitorFile.exists({
  path: 'my-file.txt',
  directory: Directory.Documents,
});

if (result.exists) {
  console.log(`Found ${result.type}`);
}

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

const stat = await CapacitorFile.stat({
  path: 'my-file.txt',
  directory: Directory.Documents,
});

console.log(`Size: ${stat.size} bytes`);
console.log(`Modified: ${new Date(stat.mtime)}`);
console.log(`Type: ${stat.type}`);