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.filePath | string | 是 | 本地文件路径(如 wxfile:// 或用户目录路径) |
options.encoding | string | 否 | 编码,默认 'utf8' |
deps | FileInMiniappDeps | 是 | 环境依赖 |
返回值
| 类型 | 说明 |
|---|---|
Promise<FileResult> | 成功含 data;缺路径或读取失败 reject |
writeFileInMiniapp
函数签名
typescript
function writeFileInMiniapp(options: FileOptions, deps: FileInMiniappDeps): Promise<FileResult>参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
options.filePath | string | 是 | 目标文件路径 |
options.data | string | ArrayBuffer | 是 | 写入内容 |
options.encoding | string | 否 | 编码,默认 'utf8' |
deps | FileInMiniappDeps | 是 | 环境依赖 |
返回值
| 类型 | 说明 |
|---|---|
Promise<FileResult> | 成功含 savedFilePath;缺参数或写入失败 reject |
工作原理
- 与 App 端实现逻辑一致:读直接
readFile;写前先mkdir递归创建父目录。 - 目录已存在时忽略
file already exists错误,继续执行writeFile。 - 统一将原生响应映射为
FileResult,保留raw供调试。