{"_id":"@capacitor-ohos/filesystem","_rev":"2-d45ec233f9db7a9d4fbb7c53b7f37a02","name":"@capacitor-ohos/filesystem","dist-tags":{"latest":"8.0.2"},"versions":{"8.0.1":{"name":"@capacitor-ohos/filesystem","version":"8.0.1","keywords":["capacitor","plugin","native"],"author":{"url":"Group","name":"Huawei Device Co., Ltd and iSoftStone Information Technology"},"license":"MIT","_id":"@capacitor-ohos/filesystem@8.0.1","maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"}],"bugs":{"url":"https://gitcode:CPF-Ionic/capacitor-filesystem/issues"},"dist":{"shasum":"39d10d6c4b0d097da1d05b7c33a21f81de0c1a70","tarball":"https://registry.npmjs.org/@capacitor-ohos/filesystem/-/filesystem-8.0.1.tgz","fileCount":10,"integrity":"sha512-DfuJBvllsjh1EuUD068PJEZcZFB2TFCFTqgOLtQf2/A5S7IwiexWvTnoA3CfRUMbbMgTSc8j2MSZYkFvDXQQJQ==","signatures":[{"sig":"MEUCIAlEWQ46RpcSS5nYSkSq810+5BUMDaf6HFC2S46GC37AAiEA60q5msgk2QsdQKyzF0GFoYsPVVI7E3LBpIej/8F0yyM=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":94139},"gitHead":"74657c1483fae3fa151f801777a8797d854f203d","_npmUser":{"name":"luqi_tan","email":"295099422@qq.com"},"capacitor":{"id":"@capacitor/filesystem","platforms":["openharmony"]},"repository":{"url":"gitcode:CPF-Ionic/capacitor-filesystem","type":"git"},"_npmVersion":"10.5.1","description":"The Filesystem API provides a NodeJS-like API for working with files on the device.","directories":{},"_nodeVersion":"22.0.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/filesystem_8.0.1_1777539948742_0.4165554310088233","host":"s3://npm-registry-packages-npm-production"}},"8.0.2":{"name":"@capacitor-ohos/filesystem","version":"8.0.2","description":"The Filesystem API provides a NodeJS-like API for working with files on the device.","capacitor":{"id":"@capacitor/filesystem","platforms":["openharmony"]},"repository":{"type":"git","url":"gitcode:CPF-Ionic/capacitor-filesystem"},"bugs":{"url":"https://gitcode:CPF-Ionic/capacitor-filesystem/issues"},"keywords":["capacitor","plugin","native"],"author":{"name":"Huawei Device Co., Ltd and iSoftStone Information Technology","url":"Group"},"license":"MIT","_id":"@capacitor-ohos/filesystem@8.0.2","gitHead":"66a644b0168859440a8d9c49f30922331d08e362","_nodeVersion":"22.0.0","_npmVersion":"10.5.1","dist":{"integrity":"sha512-ulwM8BWn70wu09xvlH7/dfJqPP9zSFpVK2o1qXGanDjKSU1qrPk0eooyXPwnSZxfFXjn+D0++EzFAQWpGXFnhw==","shasum":"f0a0292a634a61a6e34ddcd3b8809e5da547da97","tarball":"https://registry.npmjs.org/@capacitor-ohos/filesystem/-/filesystem-8.0.2.tgz","fileCount":10,"unpackedSize":94163,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIG9Kz/y6WjGwdDdRPOV9nOEkqBZu0kjE4Mmlu7f91XuSAiBZEmPqj7o1XR3blyjLuE8oEDc95m8ib0Sq8HeYX5MzAg=="}]},"_npmUser":{"name":"luqi_tan","email":"295099422@qq.com"},"directories":{},"maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/filesystem_8.0.2_1784790168538_0.9520718401652586"},"_hasShrinkwrap":false}},"time":{"created":"2026-04-30T09:05:48.603Z","modified":"2026-07-23T07:02:48.855Z","8.0.1":"2026-04-30T09:05:48.887Z","8.0.2":"2026-07-23T07:02:48.677Z"},"bugs":{"url":"https://gitcode:CPF-Ionic/capacitor-filesystem/issues"},"author":{"name":"Huawei Device Co., Ltd and iSoftStone Information Technology","url":"Group"},"license":"MIT","keywords":["capacitor","plugin","native"],"repository":{"type":"git","url":"gitcode:CPF-Ionic/capacitor-filesystem"},"description":"The Filesystem API provides a NodeJS-like API for working with files on the device.","maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"}],"readme":"# <center>@capacitor/filesystem</center>\r\n[![zh-CN](https://img.shields.io/badge/lang-中文-blue.svg)](README.md)\r\n[![en](https://img.shields.io/badge/lang-English-blue.svg)](README.en.md)\r\n\r\n本项目基于 [@capacitor/filesystem@8.0.0](https://www.npmjs.com/package/@capacitor/filesystem/v/8.0.0) 开发。\r\n\r\n## 简介\r\n\r\n@capacitor/filesystem是capacitor生态系统中的核心插件，提供完善的文件API，支持对设备本地文件系统中的文件和目录进行读写操作，为跨平台应用开发提供设备差异化适配能力，兼容Android、iOS等主流移动平台及浏览器环境中使用，本文档只说明在OpenHarmony系统中的使用。\r\n\r\nAPI允许对设备本地文件系统中的文件和目录进行读写操作。\r\n\r\n## 支持平台\r\n\r\n- **OpenHarmony**：5.0+\r\n\r\n## 下载安装\r\n\r\n通过命令行或手动引入即可快速安装插件，支持从npm仓库获取。\r\n\r\n### 命令行安装（推荐）\r\n\r\n安装hionic CLI：\r\n\r\n```bash\r\nnpm install -g hionic\r\n```\r\n\r\n以下两种方式中**任选其一**即可，无需重复操作：\r\n\r\nnpm安装：\r\n\r\n```bash\r\n# 安装插件\r\nnpm i @capacitor/filesystem\r\n\r\n# 同步插件\r\nhionic sync openharmony\r\n```\r\n\r\nhionic CLI安装：\r\n\r\n```bash\r\nhionic plugin add @capacitor/filesystem\r\n```\r\n\r\n### 手动引入安装\r\n\r\n根据插件源码中 `plugin.xml` 配置在项目中引入插件：\r\n\r\n#### 1. 添加插件配置\r\n\r\n根据 `plugin.xml` 的 `config-json` 项，通过 `target` 字段找到 `entry` 模块中 `capacitor.plugins.json` 文件，并根据 `param`\r\n标签添加配置如下：\r\n\r\n```json\r\n{\r\n  \"pkg\": \"@capacitor/filesystem\",\r\n  \"classpath\": \"Filesystem\"\r\n}\r\n```\r\n\r\n#### 2. 修改 CMake 配置\r\n\r\n根据 `plugin.xml` 的 `CMakeLists` 项，通过 `modules-name` 字段找到模块 `capacitor`，路径为 `target` 字段的\r\n`CMakeLists.txt` 文件，并根据 `param` 标签添加 `add_subdirectory` 和 `target_link_libraries` 如下：\r\n\r\n```cmake\r\n#START_ADD_SUBDIRECTORY\r\n// ...\r\nadd_subdirectory(Filesystem)\r\n// ...\r\n#END_ADD_SUBDIRECTORY\r\n\r\n// ...\r\n\r\ntarget_link_libraries(capacitor PUBLIC\r\n  \"-Wl,--whole-archive\"\r\n  // ...\r\n  Filesystem\r\n  // ...\r\n  \"-Wl,--no-whole-archive\"\r\n)\r\n```\r\n\r\n#### 3. 复制源码文件\r\n\r\n根据 `plugin.xml` 的 `source-file` 项，根据 `src` 字段找到需要复制的文件，并根据 `modules-name` 字段和 `target-dir`\r\n字段找到文件复制的具体模块和目录：\r\n\r\n将源码中src/main/cpp/Filesystem目录下的Filesystem.h、Filesystem.cpp、CMakeLists.txt文件引入到capacitor模块中src/main/cpp/Filesystem目录下。\r\n\r\n将源码中src/main/ets/components/Filesystem目录下的FilesystemAction.ets文件引入到capacitor模块中src/main/ets/components/Filesystem目录下。\r\n\r\n#### 4. 添加 ArkTS 配置\r\n\r\n在`capacitor`模块的`build-profile.json5`文件中，`buildOption/arkOptions/runtimeOnly/sources`配置项数组中加入步骤 3 中拷贝的\r\nets 文件路径：\r\n\r\n```json\r\n{\r\n  \"buildOption\": {\r\n    \"arkOptions\": {\r\n      \"runtimeOnly\": {\r\n        \"sources\": [\r\n          \"./src/main/ets/components/Filesystem/FilesystemAction.ets\"\r\n        ]\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n## 卸载\r\n\r\n```bash\r\n# 卸载 filesystem 插件\r\nhionic plugin remove @capacitor/filesystem\r\n```\r\n\r\n## 约束与限制\r\n\r\n### 兼容性\r\n\r\n在以下版本中已测试通过：\r\n\r\n- capacitor: 8.0.0-ohos-8.0.0; SDK: 5.0.5(17); IDE: DevEco Studio: 6.0.0; ROM: 5.1.0.150;\r\n\r\n### 权限要求\r\n\r\nOpenHarmony手机设备不支持公共目录访问，默认使用filesDir目录，该目录读写无需额外申请权限，权限检查与申请接口默认返回granted。\r\n\r\n## 使用示例\r\n\r\n### 示例1：读取文件内容\r\n\r\n```typescript\r\nimport { Filesystem, Directory, Encoding } from \"@capacitor/filesystem\";\r\n\r\nconst handleReadFile = async () => {\r\n  try {\r\n    const result = await Filesystem.readFile({\r\n      path: 'test.txt',\r\n      directory: Directory.Cache,\r\n      encoding: Encoding.UTF8\r\n    });\r\n    console.log('文件读取成功:', result.data);\r\n  } catch (error) {\r\n    const errorMsg = error instanceof Error ? error.message : String(error);\r\n    console.error('读取文件失败:', errorMsg);\r\n  }\r\n};\r\n```\r\n\r\n### 示例2：写入文件内容\r\n\r\n```typescript\r\nimport { Filesystem, Directory, Encoding } from \"@capacitor/filesystem\";\r\n\r\nconst handleWriteFile = async () => {\r\n  try {\r\n    const result = await Filesystem.writeFile({\r\n      path: 'test.txt',\r\n      data: '这是一个测试文件内容！',\r\n      directory: Directory.Cache,\r\n      encoding: Encoding.UTF8\r\n    });\r\n    console.log('文件写入成功:', result);\r\n  } catch (error) {\r\n    const errorMsg = error instanceof Error ? error.message : String(error);\r\n    console.error('文件写入失败:', errorMsg);\r\n  }\r\n};\r\n```\r\n\r\n### 示例3：删除文件\r\n\r\n```typescript\r\nimport { Filesystem, Directory } from \"@capacitor/filesystem\";\r\n\r\nconst handleDeleteFile = async () => {\r\n  try {\r\n    const result = await Filesystem.deleteFile({\r\n      path: 'test.txt',\r\n      directory: Directory.Cache\r\n    });\r\n    console.log('文件删除成功:', result);\r\n  } catch (error) {\r\n    const errorMsg = error instanceof Error ? error.message : String(error);\r\n    console.error('删除文件失败:', errorMsg);\r\n  }\r\n};\r\n```\r\n\r\n### 示例4：创建目录\r\n\r\n```typescript\r\nimport { Filesystem, Directory } from \"@capacitor/filesystem\";\r\n\r\nconst handleMkdir = async () => {\r\n  try {\r\n    const result = await Filesystem.mkdir({\r\n      path: 'test_dir',\r\n      directory: Directory.Cache\r\n    });\r\n    console.log('目录创建成功:', result);\r\n  } catch (error) {\r\n    const errorMsg = error instanceof Error ? error.message : String(error);\r\n    console.error('创建目录失败:', errorMsg);\r\n  }\r\n};\r\n```\r\n\r\n### 示例5：获取文件信息\r\n\r\n```typescript\r\nimport { Filesystem, Directory } from \"@capacitor/filesystem\";\r\n\r\nconst handleStat = async () => {\r\n  try {\r\n    const result = await Filesystem.stat({\r\n      path: 'test.txt',\r\n      directory: Directory.Cache\r\n    });\r\n    console.log('文件信息获取成功:', result);\r\n  } catch (error) {\r\n    const errorMsg = error instanceof Error ? error.message : String(error);\r\n    console.error('获取文件信息失败:', errorMsg);\r\n  }\r\n};\r\n```\r\n\r\n## 使用说明\r\n\r\nFilesystem是插件导出对象，可直接导入使用，导入后即可调用插件提供的所有方法，调用便捷高效，所有API均基于Promise实现，支持异步调用。\r\n\r\n| 方法名                                                                                                                                             | 返回类型                                                         | 描述            | 备注                                                                                |\r\n|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|---------------|-----------------------------------------------------------------------------------|\r\n| checkPermissions()                                                                                                                              | Promise&lt;[PermissionStatus](#permissionstatus)&gt;         | 检查读写权限        | OpenHarmony phone设备不支持公共目录访问,不支持目录默认使用filesDir,filesDir读写无需额外申请权限,因此接口返回均为granted |\r\n| requestPermissions()                                                                                                                            | Promise&lt;[PermissionStatus](#permissionstatus)&gt;         | 请求读写权限        | OpenHarmony phone设备不支持公共目录访问,不支持目录默认使用filesDir,filesDir读写无需额外申请权限,因此接口返回均为granted |\r\n| readFile(options: [ReadFileOptions](#readfileoptions))                                                                                          | Promise&lt;[ReadFileResult](#readfileresult)&gt;             | 读取文件          |                                                                                   |\r\n| readFileInChunks(options: [ReadFileInChunksOptions](#readfileinchunksoptions), callback: [ReadFileInChunksCallback](#readfileinchunkscallback)) | Promise&lt;[CallbackID](#callbackid)&gt;                     | 分块读取文件        | 仅原生平台支持                                                                           |\r\n| writeFile(options: [WriteFileOptions](#writefileoptions))                                                                                       | Promise&lt;[WriteFileResult](#writefileresult)&gt;           | 写入文件          | OpenHarmony仅支持utf-8编码                                                             |\r\n| appendFile(options: [AppendFileOptions](#appendfileoptions))                                                                                    | Promise&lt;void&gt;                                          | 向文件追加内容       | OpenHarmony仅支持utf-8编码                                                             |\r\n| deleteFile(options: [DeleteFileOptions](#deletefileoptions))                                                                                    | Promise&lt;void&gt;                                          | 删除文件          |                                                                                   |\r\n| mkdir(options: [MkdirOptions](#mkdiroptions))                                                                                                   | Promise&lt;void&gt;                                          | 创建目录          |                                                                                   |\r\n| rmdir(options: [RmdirOptions](#rmdiroptions))                                                                                                   | Promise&lt;void&gt;                                          | 删除目录          |                                                                                   |\r\n| readdir(options: [ReaddirOptions](#readdiroptions))                                                                                             | Promise&lt;[ReaddirResult](#readdirresult)&gt;               | 列出目录中的文件      |                                                                                   |\r\n| getUri(options: [GetUriOptions](#geturioptions))                                                                                                | Promise&lt;[GetUriResult](#geturiresult)&gt;                 | 获取文件/目录的完整URI |                                                                                   |\r\n| stat(options: [StatOptions](#statoptions))                                                                                                      | Promise&lt;[StatResult](#statresult)&gt;                     | 返回文件信息        |                                                                                   |\r\n| rename(options: [RenameOptions](#renameoptions))                                                                                                | Promise&lt;void&gt;                                          | 重命名文件或目录      |                                                                                   |\r\n| copy(options: [CopyOptions](#copyoptions))                                                                                                      | Promise&lt;[CopyResult](#copyresult)&gt;                     | 复制文件或目录       |                                                                                   |\r\n| downloadFile(options: [DownloadFileOptions](#downloadfileoptions))                                                                              | Promise&lt;[DownloadFileResult](#downloadfileresult)&gt;     | 下载文件          | 7.1.0后已弃用，OpenHarmony未实现,请使用@capacitor/file-transfer插件                            |\r\n| addListener('progress', listenerFunc: [ProgressListener](#progresslistener))                                                                    | Promise&lt;[PluginListenerHandle](#pluginlistenerhandle)&gt; | 添加下载进度监听器     | 7.1.0后已弃用，OpenHarmony未实现,请使用@capacitor/file-transfer插件                            |\r\n| removeAllListeners()                                                                                                                            | Promise&lt;void&gt;                                          | 移除所有监听器       | 7.1.0后已弃用，OpenHarmony未实现,请使用@capacitor/file-transfer插件                            |\r\n\r\n### 数据结构\r\n\r\n#### PermissionStatus\r\n\r\n调用 `checkPermissions` 和 `requestPermissions` 方法时的返回对象。\r\n\r\n| 属性              | 类型                | 描述   |\r\n|-----------------|-------------------|------|\r\n| `publicStorage` | `PermissionState` | 权限状态 |\r\n\r\n#### ReadFileResult\r\n\r\n调用 `readFile` 方法时的返回对象。\r\n\r\n| 属性     | 类型      | 描述    |\r\n|--------|---------|-------|\r\n| `data` | `string | Blob` | 文件内容，返回base64 encoded 字符串 |\r\n\r\n#### ReadFileOptions\r\n\r\n调用 `readFile` 方法时的参数对象。\r\n\r\n| 属性          | 类型          | 描述        |\r\n|-------------|-------------|-----------|\r\n| `path`      | `string`    | 要读取的文件路径  |\r\n| `directory` | `Directory` | 读取文件的目录   |\r\n| `encoding`  | `Encoding`  | 读取文件的编码格式 |\r\n\r\n#### ReadFileInChunksOptions\r\n\r\n调用 `readFileInChunks` 方法时的参数对象。\r\n\r\n| 属性          | 类型       | 描述       |\r\n|-------------|----------|----------|\r\n| `chunkSize` | `number` | 分块大小（字节） |\r\n\r\n#### WriteFileResult\r\n\r\n调用 `writeFile` 方法时的返回对象。\r\n\r\n| 属性    | 类型       | 描述       |\r\n|-------|----------|----------|\r\n| `uri` | `string` | 文件写入的URI |\r\n\r\n#### WriteFileOptions\r\n\r\n调用 `writeFile` 方法时的参数对象。\r\n\r\n| 属性          | 类型          | 描述                                      | 备注                                                   |\r\n|-------------|-------------|-----------------------------------------|------------------------------------------------------|\r\n| `path`      | `string`    | 要写入的文件路径                                |                                                      |\r\n| `data`      | `string     | Blob`                                   | 要写入的数据，OpenHarmony仅支持base64 encoded 字符串和 ArrayBuffer |         |\r\n| `directory` | `Directory` | 存储文件的目录                                 |                                                      |\r\n| `encoding`  | `Encoding`  | 写入文件的编码格式，OpenHarmony仅支持`Encoding.UTF8` |                                                      |\r\n| `recursive` | `boolean`   | 是否创建缺失的父目录                              | 默认`false`                                            |\r\n\r\n#### AppendFileOptions\r\n\r\n调用 `appendFile` 方法时的参数对象。\r\n\r\n| 属性          | 类型          | 描述                                      |\r\n|-------------|-------------|-----------------------------------------|\r\n| `path`      | `string`    | 要追加的文件路径                                |\r\n| `data`      | `string`    | 要写入的数据                                  |\r\n| `directory` | `Directory` | 存储文件的目录                                 |\r\n| `encoding`  | `Encoding`  | 写入文件的编码格式，OpenHarmony仅支持`Encoding.UTF8` |\r\n\r\n#### DeleteFileOptions\r\n\r\n调用 `deleteFile` 方法时的参数对象。\r\n\r\n| 属性          | 类型          | 描述       |\r\n|-------------|-------------|----------|\r\n| `path`      | `string`    | 要删除的文件路径 |\r\n| `directory` | `Directory` | 删除文件的目录  |\r\n\r\n#### MkdirOptions\r\n\r\n调用 `mkdir` 方法时的参数对象。\r\n\r\n| 属性          | 类型          | 描述         | 备注        |\r\n|-------------|-------------|------------|-----------|\r\n| `path`      | `string`    | 新目录的路径     |           |\r\n| `directory` | `Directory` | 创建新目录的父目录  |           |\r\n| `recursive` | `boolean`   | 是否创建缺失的父目录 | 默认`false` |\r\n\r\n#### RmdirOptions\r\n\r\n调用 `rmdir` 方法时的参数对象。\r\n\r\n| 属性          | 类型          | 描述         | 备注        |\r\n|-------------|-------------|------------|-----------|\r\n| `path`      | `string`    | 要删除的目录路径   |           |\r\n| `directory` | `Directory` | 删除目录的父目录   |           |\r\n| `recursive` | `boolean`   | 是否递归删除目录内容 | 默认`false` |\r\n\r\n#### ReaddirResult\r\n\r\n调用 `readdir` 方法时的返回对象。\r\n\r\n| 属性      | 类型           | 描述          |\r\n|---------|--------------|-------------|\r\n| `files` | `FileInfo[]` | 目录中的文件和目录列表 |\r\n\r\n#### FileInfo\r\n\r\n文件或目录的信息对象。\r\n\r\n| 属性      | 类型                   | 描述        |\r\n|---------|----------------------|-----------|\r\n| `name`  | `string`             | 文件或目录的名称  |\r\n| `type`  | `'file'丨'directory'` | 文件类型      |\r\n| `size`  | `number`             | 文件大小（字节）  |\r\n| `ctime` | `number`             | 创建时间（秒）   |\r\n| `mtime` | `number`             | 最后修改时间（秒） |\r\n| `uri`   | `string`             | 文件的URI    |\r\n\r\n#### ReaddirOptions\r\n\r\n调用 `readdir` 方法时的参数对象。\r\n\r\n| 属性          | 类型          | 描述       |\r\n|-------------|-------------|----------|\r\n| `path`      | `string`    | 要读取的目录路径 |\r\n| `directory` | `Directory` | 列出文件的目录  |\r\n\r\n#### GetUriResult\r\n\r\n调用 `getUri` 方法时的返回对象。\r\n\r\n| 属性    | 类型       | 描述     |\r\n|-------|----------|--------|\r\n| `uri` | `string` | 文件的URI |\r\n\r\n#### GetUriOptions\r\n\r\n调用 `getUri` 方法时的参数对象。\r\n\r\n| 属性          | 类型          | 描述          |\r\n|-------------|-------------|-------------|\r\n| `path`      | `string`    | 要获取URI的文件路径 |\r\n| `directory` | `Directory` | 获取文件的目录     |\r\n\r\n#### StatOptions\r\n\r\n调用 `stat` 方法时的参数对象。\r\n\r\n| 属性          | 类型          | 描述         |\r\n|-------------|-------------|------------|\r\n| `path`      | `string`    | 要获取信息的文件路径 |\r\n| `directory` | `Directory` | 获取文件的目录    |\r\n\r\n#### CopyOptions\r\n\r\n调用 `copy` 方法时的参数对象。\r\n\r\n| 属性            | 类型          | 描述                                     |\r\n|---------------|-------------|----------------------------------------|\r\n| `from`        | `string`    | 现有文件或目录的路径                             |\r\n| `to`          | `string`    | 目标文件或目录的路径                             |\r\n| `directory`   | `Directory` | 包含现有文件或目录的目录                           |\r\n| `toDirectory` | `Directory` | 包含目标文件或目录的目录，如果未提供则使用`directory`参数作为目标 |\r\n\r\n#### CopyResult\r\n\r\n调用 `copy` 方法时的返回对象。\r\n\r\n| 属性    | 类型       | 描述        |\r\n|-------|----------|-----------|\r\n| `uri` | `string` | 文件复制后的URI |\r\n\r\n#### DownloadFileResult\r\n\r\n调用 `downloadFile` 方法时的返回对象。\r\n\r\n| 属性     | 类型       | 描述                            |\r\n|--------|----------|-------------------------------|\r\n| `path` | `string` | 文件下载到的路径                      |\r\n| `blob` | `Blob`   | 已下载文件的 Blob 数据。此属性仅在 Web 端可用\t |\r\n\r\n#### PluginListenerHandle\r\n\r\n| 属性名    | 类型                        |\r\n|--------|---------------------------|\r\n| remove | () => Promise&lt;void&gt; |\r\n\r\n### 类型别名\r\n\r\n#### PermissionState\r\n\r\n`'granted' | 'denied'`\r\n\r\n#### ReadFileInChunksCallback\r\n\r\n接收从文件读取的块的回调，或出错时的错误。\r\n\r\n```\r\n(chunkRead: ReadFileResult | null, err?: any): void\r\n```\r\n\r\n#### CallbackID\r\n\r\n`string`\r\n\r\n#### StatResult\r\n\r\n[FileInfo](#FileInfo)\r\n\r\n#### RenameOptions\r\n\r\n[CopyOptions](#CopyOptions)\r\n\r\n#### ProgressListener\r\n\r\n接收进度事件的监听函数。\r\n\r\n```\r\n(progress: ProgressStatus): void\r\n```\r\n\r\n### 枚举\r\n\r\n#### Directory\r\n\r\n| 成员                | 值                    | 描述                                                             |\r\n|-------------------|----------------------|----------------------------------------------------------------|\r\n| `Documents`       | `'DOCUMENTS'`        | Documents目录. OpenHarmony为UserDocumentDir，phone设备不支持,默认filesDir |\r\n| `Data`            | `'DATA'`             | Data目录. OpenHarmony为filesDir                                   |\r\n| `Library`         | `'LIBRARY'`          | Library目录. OpenHarmony为filesDir                                |\r\n| `Cache`           | `'CACHE'`            | Cache目录. OpenHarmony为cacheDir                                  |\r\n| `External`        | `'EXTERNAL'`         | 外部目录. OpenHarmony不支持,默认filesDir                                |\r\n| `ExternalStorage` | `'EXTERNAL_STORAGE'` | 外部存储目录. OpenHarmony不支持,默认filesDir                              |\r\n| `ExternalCache`   | `'EXTERNAL_CACHE'`   | 外部缓存目录.  OpenHarmony不支持,默认filesDir                             |\r\n| `LibraryNoCloud`  | `'LIBRARY_NO_CLOUD'` | 不备份到云端的Library目录. OpenHarmony不支持,默认filesDir                    |\r\n| `Temporary`       | `'TEMPORARY'`        | 临时目录. OpenHarmony为tempDir                                      |\r\n\r\n## 目录结构\r\n\r\n```plaintext\r\n|---- 目录\r\n|     |---- src/main  # 插件的实现代码\r\n|           |----cpp  # C++ 代码\r\n|           |----ets   # ArkTS 代码\r\n|     |---- README.md          # 说明文档\r\n|     |---- package.json       # 配置文件\r\n|     |---- plugin.xml       # 插件配置文件\r\n```\r\n\r\n## 贡献代码\r\n\r\n使用过程中发现任何问题都可以提 [Issue](https://gitcode.com/CPF-Ionic/capacitor-filesystem/issues)\r\n，当然，也非常欢迎发 [PR](https://gitcode.com/CPF-Ionic/capacitor-filesystem/pulls) 共建。\r\n\r\n## 许可证\r\n\r\n本插件基于 **MIT License** 开源，详见 [LICENSE](./LICENSE) 文件。","readmeFilename":"README.md"}