FileSystemManager.readCompressedFile
基础库 3.74.0 开始支持本方法,这是一个异步方法。
读取指定压缩类型的本地文件内容
前提条件 | 无 |
业务背景 | 无 |
使用限制 | 无 |
注意事项 | 无 |
相关教程 | 无 |
语法
FileSystemManager.readCompressedFile(options)
参数说明
options 为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
filePath | string | 是 | 要读取的文件的路径 (本地用户文件或代码包文件) | 3.74.0 | |
compressionAlgorithm | enum | 是 | 文件压缩类型,目前仅支持 'br' | 3.74.0 | |
success | function | 否 | 接口调用成功的回调函数 | 3.74.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 3.74.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 3.74.0 |
compressionAlgorithm 的合法值
值 | 说明 | 最低支持版本 |
---|---|---|
br | brotli 压缩文件 | 3.74.0 |
回调成功
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "FileSystemManager.readCompressedFile:ok" | 3.74.0 |
data | arrayBuffer | 文件内容 | 3.74.0 |
回调失败
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "FileSystemManager.readCompressedFile:fail" + 详细错误信息 | 3.74.0 |
错误码
errNo | errMsg | 说明 | 最低支持版本 |
---|---|---|---|
20001 | invalid param | 参数错误 | 3.74.0 |
21100 | no such file or directory ${path} | 文件/目录不存在,或者目标文件路径的上层目录不存在 | 3.74.0 |
21101 | Path permission denied | 传入的路径没有权限 | 3.74.0 |
21102 | Is a directory | 指定路径是一个目录 | 3.74.0 |
21103 | brotli decompress fail | brotli解压失败(例如,指定的 compressionAlgorithm 与文件实际压缩格式不符) | 3.74.0 |
扫码体验
请使用字节宿主APP扫码
代码示例
const fs = tt.getFileSystemManager(); fs.readCompressedFile({ filePath, compressionAlgorithm: "br", success: (res) => { console.log("压缩文件读取成功", res); }, fail: (err) => { console.error("压缩文件读取失败", err); }, });