Skip to content

FileSystemManager.readZipEntry ​

JS
    FileSystemManager.readZipEntry(Object object)

读取压缩包内的文件

参数

  • Object object: 传入参数,具体的属性见下表

object 的属性说明:

属性键值类型是否必填说明
filePathstring是要读取的压缩包的路径
encodingstring否统一指定读取文件的字符编码,只在 entries 值为"all"时有效。如果 entries 值为"all"且不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容
entriesstring/Array是要读取的压缩包内的文件列表(当传入"all" 时表示读取压缩包内所有文件)
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数
completefunction否接口调用结束的回调函数

entries 数组元素属性说明:

属性键值类型是否必填说明
pathstring是压缩包内文件路径
encodingstring否指定读取文件的字符编码,如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容
positionnumber否从文件指定位置开始读,如果不指定,则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围:[0, fileLength - 1]。单位:byte
lengthnumber否指定文件的长度,如果不指定,则读到文件末尾。有效范围:[1, fileLength]。单位:byte

encoding 的合法值:

值说明
ascii按 ASCII 解码
base64编码为 base64 字符串
binaryunicode 转成字符串
hex编码为十六进制字符串
ucs2 / ucs-2以小端序读取
utf16le / utf-16le以小端序读取
utf-8 / utf8按 UTF-8 解码
latin1unicode 转成字符串

success 回调函数的参数

  • Object res: 返回读取结果

res 的属性说明:

属性键值类型说明
entriesObject文件读取结果。res.entries 是一个对象,key是文件路径,value是一个对象 FileItem ,表示该文件的读取结果。每个 FileItem 包含 data (文件内容) 和 errMsg (错误信息) 属性。

FileItem 的属性说明:

属性键值类型说明
datastring/ArrayBuffer文件内容
errMsgstring错误信息

fail 回调函数的参数

  • Object res: 返回错误信息

res 的属性说明:

属性键值类型说明
errMsgstring错误信息