Skip to content

readWriteFileInApp

App 端文件读写适配器,showFile 内部调用

前置依赖

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

readFileInApp

函数签名

typescript
function readFileInApp(options: FileOptions, deps: FileInAppDeps): Promise<FileResult>

参数

参数名类型必填说明
options.filePathstring本地文件路径
options.encodingstring编码,默认 'utf8'
depsFileInAppDeps环境依赖

返回值

类型说明
Promise<FileResult>成功含 dataerrMsg: 'readFile:ok';缺路径或 IO 失败 reject

writeFileInApp

函数签名

typescript
function writeFileInApp(options: FileOptions, deps: FileInAppDeps): Promise<FileResult>

参数

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

返回值

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

工作原理

  1. 读文件:通过 getFileSystemManager().readFile 异步读取,成功映射为统一 FileResult
  2. 写文件:先对父目录调用 mkdir({ recursive: true });目录已存在时忽略 file already exists 错误后继续写入。
  3. 参数校验失败(无路径、无内容)在调用 FS API 前即 reject,错误信息为中文提示。