抖音开放平台Logo
控制台

FileSystemManager.readFileSync
收藏
我的收藏

基础库 1.15.0 开始支持本方法，这是一个同步方法。

读取本地文件内容。

前提条件无
业务背景无
使用限制无
注意事项
readFileSync 可以用于 用户目录(ttfile://user) 临时目录(ttfile://temp) 以及 包内目录(访问包内目录不需要加额外协议头)
相关教程无

语法

FileSystemManager.readFileSync(filePath, encoding)

参数说明

filePath

类型默认值必填说明最低支持版本
string是
要读取的文件的路径
1.15.0

encoding

类型默认值必填说明最低支持版本
string否
指定读取文件的字符编码，如果不传 encoding，则以 ArrayBuffer 格式读取文件的二进制内容
1.15.0

encoding 参数说明

合法值如下：

值

说明

最低支持版本

ascii

-

1.15.0

base64

-

1.15.0

binary

-

1.15.0

hex

-

1.15.0

ucs2

以小端序读取

1.15.0

ucs-2

以小端序读取

1.15.0

utf16le

以小端序读取

1.15.0

utf-16le

以小端序读取

1.15.0

utf-8

-

1.15.0

utf8

-

1.15.0

latin1

-

1.15.0

返回值

类型说明最低支持版本
string
文件内容, 根据 encoding 设置不同返回 string 或 ArrayBuffer 类型
1.15.0

错误码

errNoerrMsg说明最低支持版本
20000readFileSync:fail filePath is invalid
filePath 参数错误
1.99.0
20001readFileSync:fail param should be xxx, but got xxx
参数校验错误
1.99.0
21101readFileSync:fail permission denied, readFileSync {filePath_value}
无操作权限(filePath 路径不可读)
1.99.0
21102readFileSync:fail operation not permitted, readFileSync {filePath_value}
类型不正确(不是文件路径)
1.99.0
21103readFileSync:fail no such file or directory, readFileSync {filePath_value}
filePath 文件不存在
1.99.0

代码示例

const fileSystemManager = tt.getFileSystemManager();

tt.chooseImage({
  success(res) {
    try {
      const data = fileSystemManager.readFileSync(res.tempFilePaths[0]);
      console.log("调用成功", data);
    } catch (err) {
      console.log("调用失败", err);
    }
  },
});