Firebase Storage Capacitor 插件

使用 @capgo/capacitor-firebase-storage

适用于 Firebase Cloud Storage 的 Capacitor 插件

安装

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

bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。

导入

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

API 概览

方法	描述
deleteFile	删除文件。
getDownloadUrl	获取文件的下载链接。
getMetadata	获取文件的元数据。
listFiles	列出目录中的文件。
updateMetadata	更新文件的元数据。
downloadFile	下载文件。
uploadFile	上传文件。
useEmulator	配置您的 App 以连接 Cloud Storage 模拟器。

示例

deleteFile()

删除文件。

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

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

getDownloadUrl()

获取文件的下载链接。

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

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

getMetadata()

获取文件的元数据。

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

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

listFiles()

列出目录中的文件。

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()

更新文件的元数据。

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

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

downloadFile()

下载文件。

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

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

上表列出了 8 个核心方法。有关 Listener 和 version 辅助函数以及每个方法的完整契约，请参阅 GitHub 仓库.

完整参考文档

• GitHub 仓库
• 文档
• API 参考文档

继续探索 @capgo/capacitor-firebase-storage 的用法

如果你正在使用 使用 @capgo/capacitor-firebase-storage 要规划存储和文件处理，请将其与 @capgo/capacitor-data-storage-sqlite 关于 @capgo/capacitor-data-storage-sqlite 中的实现细节， 使用 @capgo/capacitor-data-storage-sqlite 关于使用 @capgo/capacitor-data-storage-sqlite 的原生能力， @capgo/capacitor-file 关于 @capgo/capacitor-file 中的实现细节， 使用 @capgo/capacitor-file 用于“使用 @capgo/capacitor-file”中的原生能力，以及 @capgo/capacitor-uploader 了解 @capgo/capacitor-uploader. 的实现细节