# Interface: FileSystemManagerReadFileParams ‹Err›
• FileSystemManagerReadFileParams‹Err›()
# Type parameters:
▪ Err: MogsRes
# Type parameters
▪ Err: MogsRes
# Properties
# Optional
encoding
• encoding? : Encoding
指定读取文件的字符编码,如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容
Returns: Encoding
# filePath
• filePath: string
要读取的文件的路径 (本地路径)
Returns: string
# Optional
length
• length? : string
指定文件的长度,如果不指定,则读到文件末尾。
description
有效范围:[1, fileLength]。
单位:byte
todo
wx 文档似乎有误,这里的类型看描述,应为 number
Returns: string
# Optional
position
• position? : string
从文件指定位置开始读,如果不指定,则从文件头开始读。
description
读取的范围应该是左闭右开区间 [position, position+length)。
有效范围:[0, fileLength - 1]。
单位:byte
todo
wx 文档似乎有误,这里的类型看描述,应为 number
Returns: string
# Methods
# Optional
complete
▸ complete(res
: FileSystemManagerReadFileRes | Err): void
Inherited from MogsParams.complete
接口调用结束的回调函数(调用成功、失败都会执行)
# 参数:
属性 | 类型 |
---|---|
res | FileSystemManagerReadFileRes | Err |
# 返回值:
void
# Optional
fail
▸ fail(err
: Err): void
Inherited from MogsParams.fail
接口调用失败的回调函数
# 参数:
属性 | 类型 |
---|---|
err | Err |
# 返回值:
void
# Optional
success
▸ success(res
: FileSystemManagerReadFileRes): void
Inherited from MogsParams.success
接口调用成功的回调函数
# 参数:
属性 | 类型 |
---|---|
res | FileSystemManagerReadFileRes |
FileSystemManagerReadFileRes
属性 | 类型 | 描述 |
---|---|---|
data | string | ArrayBuffer | 文件内容 |
errMsg | string | API 调用成功/失败的消息 |
# 返回值:
void