@capgo/capacitor-file

Capacitor 文件插件实现类似于 Cordova File 插件的文件系统操作。

概述

Capacitor 文件插件实现了类似 Cordova File 插件的文件系统操作。

核心功能

requestFileSystem - 请求文件系统。
resolveLocalFileSystemURL - 解析文件 URL 到一个入口。
getFile - 获取一个文件入口。
getDirectory - 获取一个目录项。

API（公共）

方法	描述
`requestFileSystem`	请求一个文件系统。
`resolveLocalFileSystemURL`	将一个文件 URL 解析为一个目录项。
`getFile`	获取一个文件项。
`getDirectory`	获取一个目录项。
`readFile`	以文本或 base64 格式读取一个文件。
`readAsDataURL`	以 base64 格式（带 MIME 类型前缀）读取一个文件（作为数据 URL）。
`writeFile`	写入一个文件。
`appendFile`	在文件中追加数据.
`deleteFile`	删除一个文件.
`mkdir`	创建一个目录.
`rmdir`	删除一个目录.
`readdir`	读取目录内容.
`stat`	获取文件或目录的元数据.
`getMetadata`	获取文件或目录的元数据。stat()的别名.
`rename`	重命名或移动一个文件或目录.
`move`	移动一个文件或目录。rename()的别名.
`copy`	复制一个文件或目录.
`exists`	检查一个文件或目录是否存在.
`getUri`	获取一个文件的URI.
`truncate`	截断文件到指定大小。
`getDirectories`	获取已知的文件系统目录。
`getFreeDiskSpace`	获取可用磁盘空间（以字节为单位）。
`addListener`	监听读取进度事件。
`addListener`	监听写入进度事件。
`removeAllListeners`	移除所有事件监听器。
`getPluginVersion`	获取插件版本。
`checkPermissions`	检查当前文件操作权限状态。Android 上检查外部存储权限，iOS 和 web 上始终返回 ‘已授权’，因为不需要特殊权限。
`requestPermissions`	请求文件操作权限。Android 上请求外部存储权限，用于访问应用私有目录外的文件。iOS 和 web 上始终返回 ‘已授权’，因为不需要特殊权限。

参考值

在选择存储位置、编写编码文本或处理文件错误时，请使用这些值。

值	用户会发现
`DOCUMENTS`	持久的用户可见文档。在 Android 上，这映射到应用文件目录。
`DATA`	持久的私有应用数据。
`LIBRARY`	持久的非用户可见应用数据。在 Android 上，这映射到应用文件目录。
`CACHE`	操作系统可能清除的临时缓存数据。
`EXTERNAL`	Android外部存储根目录，例如SD卡或共享外部存储。
`EXTERNAL_STORAGE`	Android外部存储数据目录。
`APPLICATION`	只读的应用程序包或资产目录。

编码

值	使用
`utf8`	UTF-8 文本。
`ascii`	ASCII 文本。
`utf16`	UTF-16 文本。

文件错误代码

值	Code	含义
`NOT_FOUND_ERR`	`1`	文件或目录未找到。
`SECURITY_ERR`	`2`	由于安全规则或权限被阻止的操作。
`ABORT_ERR`	`3`	操作被中止。
`NOT_READABLE_ERR`	`4`	无法读取文件或目录。
`ENCODING_ERR`	`5`	编码无效或不受支持。
`NO_MODIFICATION_ALLOWED_ERR`	`6`	目标无法修改。
`INVALID_STATE_ERR`	`7`	对象状态无效以执行此操作。
`SYNTAX_ERR`	`8`	路径或输入语法无效。
`INVALID_MODIFICATION_ERR`	`9`	请求的更改无效的目标。
`QUOTA_EXCEEDED_ERR`	`10`	存储配额已超出。
`TYPE_MISMATCH_ERR`	`11`	值类型与预期类型不符。
`PATH_EXISTS_ERR`	`12`	目标路径已存在。

真实来源

This reference is synced from src/definitions.ts 在 capacitor-文件.

Keep going from @capgo/capacitor-文件

如果您正在使用 @capgo/capacitor-文件 来规划存储和文件处理，连接它与使用 @capgo/capacitor-文件来实现原生能力的 Using @capgo/capacitor-文件中的 @capgo/capacitor-数据存储-sqlite 对于 @capgo/capacitor-data-storage-sqlite 的实现细节使用 @capgo/capacitor-data-storage-sqlite 对于 @capgo/capacitor-data-storage-sqlite 的本机能力 @capgo/capacitor-uploader 对于 @capgo/capacitor-uploader 的实现细节使用 @capgo/capacitor-uploader 对于 @capgo/capacitor-uploader 的本机能力