小程序开放平台

文档中心
暂无目录

xhs.writeFileSync

更新时间:2024-11-14 11:47:48

以 Promise 风格 调用:不支持

功能描述

FileSystemManager.writeFile 的同步版本

参数

Object object

属性
类型
默认值
必填
说明
filePathstring要写入的文件路径 (本地路径)
datastring/ArrayBuffer要写入的文本或二进制数据
encodingstringutf8指定写入文件的字符编码
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

encoding的合法值

合法值
说明
ascii
base64(注意,选择 base64 编码,data 只需要传 base64 内容本身,不要传 Data URI 前缀,否则会报 fail base64 encode error 错误。例如,传 aGVsbG8= 而不是传 data:image/png;base64,aGVsbG8= )
binary
hex
ucs2以小端序读取
ucs-2以小端序读取
utf16le以小端序读取
utf-16le以小端序读取
utf-8
utf8
latin1

示例代码

const fs = xhs.getFileSystemManager()
fs.writeFile({
  filePath: `${xhs.env.USER_DATA_PATH}/hello.txt`,
  data: 'some text or arrayBuffer',
  encoding: 'utf8',
  success(res) {
    console.log(res)
  },
  fail(res) {
    console.error(res)
  }
})

// 同步接口
try {
  const res = fs.writeFileSync(
    `${xhs.env.USER_DATA_PATH}/hello.txt`,
    'some text or arrayBuffer',
    'utf8'
  )
  console.log(res)
} catch(e) {
  console.error(e)
}