@capgo/capacitor-file

Capacitor 文件插件

概述

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

核心功能

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

Public API

方法	描述
`requestFileSystem`	请求一个文件系统。
`resolveLocalFileSystemURL`	将文件 URL 解析为一个入口。
`getFile`	获取一个文件入口。
`getDirectory`	获取一个目录入口。
`readFile`	读取文件为文本或base64。
`readAsDataURL`	读取文件为数据URL（base64加 MIME类型前缀）。
`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`	目标路径已存在

真实数据来源

此参考资料是从 src/definitions.ts 在 capacitor-file.

从@capgo/capacitor-file继续

如果您正在使用 @capgo/capacitor-file 来规划存储和文件处理，连接它使用@capgo/capacitor-file 为@capgo/capacitor-file的本地能力 @capgo/capacitor-data-storage-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的本地能力