📌 从基础库 3.125.4 版本开始支持
读取本地文件内容。单个文件大小上限为100M。
属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| filePath | string | 是 | 要读取的文件的路径 (本地路径) | |
| encoding | string | 否 | 指定读取文件的字符编码，如果不传 encoding，则以 ArrayBuffer 格式读取文件的二进制内容。 小红书仅支持以下编码格式： utf-8 utf8 binary | |
| position | number | 否 | 从文件指定位置开始读，如果不指定，则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围：0, fileLength - 1。单位：byte | |
| length | number | 否 | 指定文件的长度，如果不指定，则读到文件末尾。有效范围：1, fileLength。单位：byte | |
| success | function | 否 | 接口调用成功的回调函数 | |
| fail | function | 否 | 接口调用失败的回调函数 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
属性 | 类型 | 说明 |
|---|---|---|
| data | string/ArrayBuffer | 文件内容 |
✅ 小红书平台支持：
❌ 不支持的编码：
ascii/hex/ucs2/ucs-2/utf16le/utf-16le/latin1
const fs = xhs.getFileSystemManager()
// 异步接口
fs.readFile({
filePath: `${xhs.env.USER_DATA_PATH}/hello.txt`,
encoding: 'utf8',
position: 0,
success(res) {
console.log(res.data)
},
fail(res) {
console.error(res)
}
})
// 同步接口
try {
const res = fs.readFileSync(
`${xhs.env.USER_DATA_PATH}/hello.txt`,
'utf8',
0
)
console.log(res)
} catch(e) {
console.error(e)
}