抖音开放平台Logo
控制台

FileSystemManager.writeFile
收藏
我的收藏

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

写文件，只能写入用户目录(ttfile://user)。

前提条件无
业务背景无
使用限制无
注意事项
每个小程序的用户目录存储上限为 10M，不同小程序的用户目录相互隔离。
支持沙盒
否
相关教程无

语法

FileSystemManager.writeFile(options)

参数说明

options 为 object 类型，属性如下：

属性名类型默认值必填说明最低支持版本
encodingenumutf8否
指定写入文件的字符编码
1.15.0
datastring | arraybuffer是
要写入的文本或二进制数据
1.15.0
filePathstring是
要写入的文件路径, 必须以 `ttfile://user` 开头
1.15.0
successfunction否
接口调用成功的回调函数
1.15.0
failfunction否
接口调用失败的回调函数
1.15.0
completefunction否
接口调用结束的回调函数（调用成功、失败都会执行）
1.15.0

encoding 的合法值

值说明最低支持版本
utf-8

RFC 3629, Section 4

1.15.0
ascii

MDN

1.15.0
base64

RFC 4648, Section 5

1.15.0
binary
ISO-8859-1
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
utf8

RFC 3629, Section 4

1.15.0
latin1

ISO-8859-1

1.15.0

回调成功

object 类型，属性如下：

属性名类型说明最低支持版本
errMsgstring

"writeFile:ok"

1.15.0

回调失败

object 类型，属性如下：

属性名类型说明最低支持版本
errMsgstring

"writeFile:fail" + 详细错误信息

1.15.0

错误码

errNoerrMsg说明最低支持版本
20000writeFile:fail filePath is invalid
filePath 参数错误
1.99.0
20000writeFile:fail data is invalid
data 传入参数类型不正确
1.99.0
21101writeFile:fail permission denied, writeFile %s
文件路径不可写
1.99.0
21102writeFile:fail no such file or directory, writeFile %s
路径父级目录不存在
1.99.0
21103writeFile:fail user dir saved file size limit exceeded
超出目录大小限制
1.99.0
21104writeFile:fail operation not permitted, writeFile %s
filePath 类型不是文件
1.99.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

const fileSystemManager = tt.getFileSystemManager()

const filePath = `ttfile://user/example.txt`

fileSystemManager.writeFile({
  filePath,
  encoding: "utf8",
  data: "example content",
  success(_res) {
    console.log("调用成功")
    const data = fileSystemManager.readFileSync(filePath)
    console.log("写入的内容为:", data)
  },
  fail(res) {
    console.log("调用失败", res.errMsg)
  },
})