Firebase Storage Capacitor plugin

Using @capgo/capacitor-firebase-storage

Capacitor plugin for Firebase Cloud Storage.

Install

bun add @capgo/capacitor-firebase-storage
bunx cap sync

bunx cap sync copies the plugin's native code into your native projects. Run it again after every plugin upgrade.

Import

import { FirebaseStorage } from '@capgo/capacitor-firebase-storage';

API at a glance

Examples

deleteFile()

Delete a file.

import { FirebaseStorage } from '@capgo/capacitor-firebase-storage';

await FirebaseStorage.deleteFile({ path: 'mountains.png' });

getDownloadUrl()

Get the download url for a file.

import { FirebaseStorage } from '@capgo/capacitor-firebase-storage';

const result = await FirebaseStorage.getDownloadUrl({ path: 'mountains.png' });
console.log(result);

getMetadata()

Get the metadata for a file.

import { FirebaseStorage } from '@capgo/capacitor-firebase-storage';

const result = await FirebaseStorage.getMetadata({ path: 'mountains.png' });
console.log(result);

listFiles()

List files in a directory.

import { FirebaseStorage } from '@capgo/capacitor-firebase-storage';

const result = await FirebaseStorage.listFiles({ path: 'path/to/file' });
// The result holds sensitive values: use it without logging it.

updateMetadata()

Update the metadata for a file.

import { FirebaseStorage } from '@capgo/capacitor-firebase-storage';

await FirebaseStorage.updateMetadata({
  path: 'path/to/file',
  metadata: {},
});

downloadFile()

Download a file.

import { FirebaseStorage } from '@capgo/capacitor-firebase-storage';

const result = await FirebaseStorage.downloadFile({ path: 'mountains.png' }, (event, error) => {
  console.log(event);
});
console.log(result);

The table above lists the 8 core methods. Listener and version helpers, and the full contract of each method, are documented in the GitHub repository.

Full reference

• GitHub repository
• Documentation
• API reference

Keep going from Using @capgo/capacitor-firebase-storage

If you are using Using @capgo/capacitor-firebase-storage to plan storage and file handling, connect it with @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, @capgo/capacitor-file for the implementation detail in @capgo/capacitor-file, Using @capgo/capacitor-file for the native capability in Using @capgo/capacitor-file, and @capgo/capacitor-uploader for the implementation detail in @capgo/capacitor-uploader.