Skip to content

readWriteFileInMiniapp

小程序端文件读写适配器,showFile 内部调用

前置依赖

typescript
interface FileInMiniappDeps {
  getFileSystemManager: UniApp['getFileSystemManager']
  log: Console['log']
  error: Console['error']
}
依赖说明
getFileSystemManager获取小程序文件系统管理器
log / error成功 / 失败日志

readFileInMiniapp

函数签名

typescript
function readFileInMiniapp(options: FileOptions, deps: FileInMiniappDeps): Promise<FileResult>

参数

参数名类型必填说明
options.filePathstring本地文件路径(如 wxfile:// 或用户目录路径)
options.encodingstring编码,默认 'utf8'
depsFileInMiniappDeps环境依赖

返回值

类型说明
Promise<FileResult>成功含 data;缺路径或读取失败 reject

writeFileInMiniapp

函数签名

typescript
function writeFileInMiniapp(options: FileOptions, deps: FileInMiniappDeps): Promise<FileResult>

参数

参数名类型必填说明
options.filePathstring目标文件路径
options.datastring | ArrayBuffer写入内容
options.encodingstring编码,默认 'utf8'
depsFileInMiniappDeps环境依赖

返回值

类型说明
Promise<FileResult>成功含 savedFilePath;缺参数或写入失败 reject

工作原理

  1. 与 App 端实现逻辑一致:读直接 readFile;写前先 mkdir 递归创建父目录。
  2. 目录已存在时忽略 file already exists 错误,继续执行 writeFile
  3. 统一将原生响应映射为 FileResult,保留 raw 供调试。