Skip to main content
Capgo logo
Back to plugins
@capgo/capacitor-file
Tutorial
by github.com/Cap-go

File

Full-featured file system plugin for reading, writing, and managing files and directories

Downloads/week

2.7k

GitHub Stars

4

Guide

Tutorial on File

Using @capgo/capacitor-file

Capacitor File Plugin Implements file system operations similar to the Cordova File plugin.

Install

bun add @capgo/capacitor-file
bunx cap sync

What This Plugin Exposes

  • requestFileSystem - Request a file system.
  • resolveLocalFileSystemURL - Resolve a file URL to an entry.
  • getFile - Get a file entry.
  • getDirectory - Get a directory entry.

Example Usage

requestFileSystem

Request a file system.

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

await CapacitorFile.requestFileSystem({} as RequestFileSystemOptions);

resolveLocalFileSystemURL

Resolve a file URL to an entry.

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

await CapacitorFile.resolveLocalFileSystemURL({} as ResolveURLOptions);

getFile

Get a file entry.

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

await CapacitorFile.getFile({} as GetFileOptions);

getDirectory

Get a directory entry.

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

await CapacitorFile.getDirectory({} as GetDirectoryOptions);

Full Reference

Keep going from Using @capgo/capacitor-file

If you are using Using @capgo/capacitor-file to plan storage and file handling, connect it with @capgo/capacitor-file for the implementation detail in @capgo/capacitor-file, Getting Started for the implementation detail in Getting Started, @capgo/capacitor-data-storage-sqlite for the implementation detail in @capgo/capacitor-data-storage-sqlite, Using @capgo/capacitor-data-storage-sqlite for the native capability in Using @capgo/capacitor-data-storage-sqlite, and @capgo/capacitor-uploader for the implementation detail in @capgo/capacitor-uploader.