@ capgo/ 电容文件

使用兼容 API 的 Capacitor app 设备文件系统工作 cordova-plugin-file。在iOS、Android和网络上读取、撰写、复制并移动文件和文件夹.

🤖 建筑与AI编码代理? 安装 Capgo 技能 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 @capgo/capacitor-file 在您的电容应用程序中: npx skills add Cap-go/capgo-skills。然后问你的经纪人: 添加@capgo/capacor-file到我的Capacitor应用上并把它接上 代理设置指南 • 妇女 主机磁共振

主要特点

• 读写数字 : readFile(), (中文(简体) ), readAsDataURL(), (中文(简体) ), writeFile(), (中文(简体) ), appendFile() 财务报告和审定财务报表 truncate()。 。 。 .
• 文件与文件夹数字 : mkdir(), (中文(简体) ), rmdir(), (中文(简体) ), readdir(), (中文(简体) ), copy(), (中文(简体) ), move(), (中文(简体) ), rename() 财务报告和审定财务报表 deleteFile()。 。 。 .
• 元数据数字 : stat(), (中文(简体) ), exists(), (中文(简体) ), getUri() 财务报告和审定财务报表 getFreeDiskSpace()。 。 。 .
• Cordova 兼容数字 : requestFileSystem(), (中文(简体) ), resolveLocalFileSystemURL(), (中文(简体) ), getFile() 财务报告和审定财务报表 getDirectory() 方便从 cordova-plugin-file。 。 。 .
• 权限数字 : checkPermissions() 财务报告和审定财务报表 requestPermissions() 用于存储访问.
• 平台: iOS,Android和Web. 互联网档案馆的存檔,存档日期2013-12-02. Web将核心文件操作保存在浏览器存储中.

为什么是控制器文件?

一个可靠的 本地文件系统 为 Capacitor 应用程序所建的插件, 具有官方文件系统插件中没有的高级特性 :

• 部分文件读取 - 读取文件的具体部分 offset 财务报告和审定财务报表 length 参数( 大文件大)
• 随机访问写入 - 在具体字节位置写作 position 参数
• Cordova 兼容的 API - 熟悉的方法,比如: requestFileSystem(), (中文(简体) ), resolveLocalFileSystemURL(), (中文(简体) ), getFile(),以及 getDirectory()
• 所有平台目录 - 查阅文件、图书馆、缓存、外部存储等
• 进展活动 - 通过实时更新进度,监测阅读/写入操作
• 自由和开放源代码 - 不需要有偿服务

适合需要与大文件合作,从Cordova迁移,或需要随机访问文件操作的应用程序.

文档

这里有最完整的医生: https://capgo.app/docs/plugins/files/ 互联网档案馆的存檔,存档日期2013-12-02

兼容性

说明: 此插件的主要版本沿用了Capacitor的主要版本. 使用匹配您的 Capacitor 安装的版本( 如 Capacitor 8 的插件 v8) 。 只有最新的主要版本得到积极维护.

安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

然后使用下列提示:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-file` plugin in my project.

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

npm install @capgo/capacitor-file
npx cap sync

Android 媒体权限和谷歌播放审查

在Android 13+上,此插件可以请求广泛的媒体权限,例如 READ_MEDIA_IMAGES 财务报告和审定财务报表 READ_MEDIA_VIDEO 当你打电话 requestPermissions() 在您的应用程序的私人目录之外访问 .

Google Play只允许这些相片和视频权限,当访问与你的app的核心目的直接相关,需要持续或频繁访问共享存储中的照片或视频. 如果您的应用只需要一次性或不频繁的媒体访问,例如导入一个配置图片,选择附件,或者选择一个文件上传,Google期望您使用一个系统拾取器代替.

在发布请求这些权限的应用程序之前 :

• 确保照片或视频库的访问是您的应用程序核心功能的一部分.
• 准备好为Play Console审查中的许可使用说明理由.
• 如果应用程序只能与用户选择的文件合作,则删除宽媒体权限 .

如果 Google Play 审查以类似消息拒绝应用程序 Photo and Video Permissions policy: Permission use is not directly related to your app's core purpose,使用时 @ capgo/ 电容器- 文件拾取器 或另一个系统采取器流,而不是请求宽相/视频权限.

见谷歌 图片和视频权限政策 目前审查所需经费.

API 密码

• requestFileSystem(...)
• resolveLocalFileSystemURL(...)
• getFile(...)
• getDirectory(...)
• readFile(...)
• readAsDataURL(...)
• writeFile(...)
• appendFile(...)
• deleteFile(...)
• mkdir(...)
• rmdir(...)
• readdir(...)
• stat(...)
• getMetadata(...)
• rename(...)
• move(...)
• copy(...)
• exists(...)
• getUri(...)
• truncate(...)
• getDirectories()
• getFreeDiskSpace()
• addListener('readProgress', ...)
• addListener('writeProgress', ...)
• removeAllListeners()
• getPluginVersion()
• checkPermissions()
• requestPermissions(...)
• 接口
• 类型异名
• 数字

电容文件插件 执行类似 Cordova 文件插件的文件系统操作

请求FileSystem (...)

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

请求文件系统 .

回返情况: Promise<FileSystem>

解析本地文件SystemURL(...)

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

将文件 URL 解析为条目 .

回返情况: Promise<Entry>

获取文件(...)

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

获取文件条目 .

回返情况: Promise<FileEntry>

获取 Directy (...)

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

获取目录条目 .

回返情况: Promise<DirectoryEntry>

读取文件(...)

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

读取文件为文本或碱基64.

回返情况: Promise<ReadFileResult>

读取 AsDataURL(...)

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

将一个文件读取为数据 URL(base64 有 MIME 类型前缀).

回返情况: Promise<{ data: string; }>

写入文件(...)

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

将数据写入文件 .

回返情况: Promise<WriteFileResult>

附加文件(...)

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

将数据添加到文件中 .

回返情况: Promise<WriteFileResult>

删除文件(...)

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

删除文件 .

mkdir (...) (中文(简体) )

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

创建目录 .

rmdir (...) (中文(简体) )

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

删除目录 .

已读 dir (...)

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

读取目录内容 .

回返情况: Promise<ReaddirResult>

数据(...)

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

获取文件或目录的元数据 .

回返情况: Promise<StatResult>

获取气象数据(...)

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

获取文件或目录的元数据 . 别名为 stat ().

回返情况: Promise<Metadata>

重命名(...)

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

重命名或移动文件或目录.

移动(...)

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

移动文件或目录 . 重命名的别名 ().

复制(...)

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

复制文件或目录 .

回返情况: Promise<CopyResult>

已存在(...)

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

检查文件或目录是否存在 .

回返情况: Promise<ExistsResult>

获取Uri(...)

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

获取URI文件 .

回返情况: Promise<GetUriResult>

切变(...)

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

将文件截断到指定大小.

获取董事( )

getDirectories() => Promise<FileDirectories>

获取所有已知的文件系统目录 .

回返情况: Promise<FileDirectories>

获取 FreeDisk Space ()

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

在字节中获取自由磁盘空间 .

回返情况: Promise<{ free: number; }>

添加倾听器( 读取进度 )..

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

听读进度事件.

回返情况: Promise<PluginListenerHandle>

添加倾听器( “ 写入进度 ” ,...)

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

听写进度事件.

回返情况: Promise<PluginListenerHandle>

删除所有收听器( )

removeAllListeners() => Promise<void>

删除全部事件听众 .

获取 PluginVersion ()

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

获取插件版本 .

回返情况: Promise<{ version: string; }>

检查( )

checkPermissions() => Promise<FilePermissionStatus>

请检查当前文件操作的权限状态 . 在Android上,此检查外部存储权限. 在iOS和网络上,这总是返回"被授予",因为不需要特殊权限.

回返情况: Promise<FilePermissionStatus>

请求(...)

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

请求文件操作权限 . 在Android上,此请求需要外部存储权限 访问应用程序的私人目录以外的文件 . 在iOS和网络上,这总是返回"被授予",因为不需要特殊权限.

回返情况: Promise<FilePermissionStatus>

接口

文件系统

代表一个文件系统

目录条目

代表目录条目

请求文件系统选项

请求文件系统的选项

条目

代表一个文件或目录条目

选项

解决 URL 到条目的选项

文件条目

代表文件条目

获取文件选项

获取文件的选项

获取选项

创建或获取文件/目录的选项

获取切换选项

获取目录的选项

读取结果

读取文件的结果

读取文件选项

读取文件的选项

写入文件

编写文件的结果

写入文件选项

写入文件的选项

删除文件选项

删除文件或目录的选项

Mkdir 选项

创建目录的选项

删除标题选项

递归删除目录的选项

读取结果

读取目录的结果

读取目录选项

读取目录的选项

静态

获得文件/目录信息的结果

状态选项

获取文件信息的选项

元数据

代表文件或目录的元数据

重命名选项

重命名/移动文件或目录的选项

复制结果

复制操作结果

复制选项

复制文件或目录的选项

现成

存在结果检查

已存在选项

检查文件或目录是否存在的选项

GetUriResult (英语)

获得URI的结果

获取选项

获取文件 URI 选项

截断选项

文件切换选项

文件目录

插件曝光的已知文件系统目录

插件听筒

进展活动

文件操作进度事件

文件发送状态

文件操作的权限状态

权限请求选项

请求权限的选项

类型异名

权限状态

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'

数字

文件系统Type

目录

编码

用法实例

正在读取文件

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}`);

从 cordova-plugin- file 迁移

此插件提供类似的功能至 cordova-plugin-file 还有更现代的API. 简而言之:

许可证

MPL - 2.0 导弹