taro Documentation

1. Project Overview & Quickstart (NervJS/taro)

File: README.md

简介

开放式跨端跨框架解决方案，支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。现如今市面上端的形态多种多样，Web、React Native、微信小程序等各种端大行其道，当业务要求同时在不同的端都要求有所表现的时候，针对不同的端去编写多套代码的成本显然非常高，这时候只编写一套代码就能够适配到多端的能力就显得极为需要

版本迁移

Taro 1/2 迁移至 Taro 3，请阅读《Taro 版本升级权威指南》

学习资源

5 分钟上手 Taro 开发

awesome-taro

社区共享

Taro 物料市场——让每一个轮子产生价值

UI 库

名称	地址	介绍	支持的框架	支持的 Taro 版本
taro-ui	https://taro-ui.jd.com/#/	一套基于 Taro 框架开发的多端 UI 组件库	React	Taro 1/2/3
NutUI	https://nutui.jd.com/#/	京东风格的轻量级移动端 Vue 组件库	Vue3	Taro 3
taroify	https://taroify.github.io/taroify.com/introduce/	轻量、可靠的小程序端 Taro 组件库（Vant 的 Taro 版本）	React	Taro 3
@antmjs/vantui	https://antmjs.github.io/vantui/#/home	基于有赞 VantWeapp 开发的同时支持 Taro 和 React 的 UI 库	React	Taro 3
Tard	https://tard-ui.selling.cn/	一套基于 Taro 框架开发的多端 React UI 组件库	React	Taro 3
duxui	https://duxapp.cn/docs/duxui/start/	一套能同时兼容小程序、React Native、鸿蒙、H5的移动端ui组件库	React	Taro 4

项目状态

使用案例

Taro 已经投入了我们的生产环境中使用，业界也在广泛地使用 Taro 开发多端应用。

征集更多优秀案例

加入共建

加入 Taro 社区共建倡议

Taro 邀你加入社区共建

为 Taro 贡献代码

Taro 非常欢迎社区开发者为 Taro 贡献代码，在贡献之前请先阅读贡献指南。

如果你想为 Taro 实现一个重要功能，需要先撰写 RFC 文档，按照 Taro 的RFC 机制进行操作，在经过社区讨论完善后才可以进行代码的提交。

问题反馈与建议

给 Taro 提 ISSUE

特别鸣谢


nanjingboy	jsNewbee	Qiyu8	Garfield Lee

贡献者们

开发计划

Milestones

更新日志

本项目遵从 Angular Style Commit Message Conventions，更新日志请查阅 Release。

开发交流

官方交流微信群

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

File: docs/apis/framework/App.md

注册小程序。接受一个 Object 参数，其指定小程序的生命周期回调等。

方法

File: docs/apis/framework/getApp.md

获取到小程序全局唯一的 App 实例。

类型

tsx

<T = Record<string, any>>(opts?: Option) => Instance<T>

参数

Option

参数	类型	必填	说明
allowDefault	`boolean`	否	在 `App` 未定义时返回默认实现。当App被调用时，默认实现中定义的属性会被覆盖合并到App中。一般用于独立分包

Instance

API 支持度

API	微信小程序	百度小程序	支付宝小程序	字节跳动小程序	QQ 小程序	京东小程序	H5	React Native	快应用
Taro.getApp	✔️	✔️	✔️	✔️	✔️	✔️	✔️	✔️	✔️

File: docs/apis/framework/getCurrentPages.md

获取当前页面栈。数组中第一个元素为首页，最后一个元素为当前页面。
注意：

不要尝试修改页面栈，会导致路由以及页面状态错误。
不要在 App.onLaunch 的时候调用 getCurrentPages()，此时 page 还没有生成。

类型

tsx

() => Page[]

参数

示例代码

tsx

Taro.getCurrentPages().length

API 支持度

API	微信小程序	H5	React Native
Taro.getCurrentPages	✔️	✔️

File: docs/apis/framework/Page.md

注册小程序中的一个页面。接受一个 Object 类型参数，其指定页面的初始数据、生命周期回调、事件处理函数等。

方法

参数	类型	说明
route	`string`	当前页面的路径

File: docs/apis/files/FileSystemManager.md

文件管理器

方法

readdirSync

FileSystemManager.readdir 的同步版本

tsx

(dirPath: string) => string[]

参数	类型	说明
dirPath	`string`	要读取的目录路径

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.readdirSync	✔️

access

判断文件/目录是否存在

tsx

(option: AccessOption) => void

参数	类型
option	`AccessOption`

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.access	✔️

accessSync

FileSystemManager.access 的同步版本

tsx

(path: string) => void

参数	类型	说明
path	`string`	要判断是否存在的文件/目录路径

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.accessSync	✔️

appendFile

在文件结尾追加内容

tsx

(option: AppendFileOption) => void

参数	类型
option	`AppendFileOption`

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.appendFile	✔️

appendFileSync

FileSystemManager.appendFile 的同步版本

tsx

(filePath: string, data: string | ArrayBuffer, encoding?: "ascii" | "base64" | "binary" | "hex" | "ucs2" | "ucs-2" | "utf16le" | "utf-16le" | "utf-8" | "utf8" | "latin1") => void

参数	类型	说明
filePath	`string`	要追加内容的文件路径
data	string or ArrayBuffer	要追加的文本或二进制数据
encoding	"ascii" or "base64" or "binary" or "hex" or "ucs2" or "ucs-2" or "utf16le" or "utf-16le" or "utf-8" or "utf8" or "latin1"	指定写入文件的字符编码

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.appendFileSync	✔️

copyFile

复制文件

tsx

(option: CopyFileOption) => void

参数	类型
option	`CopyFileOption`

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.copyFile	✔️

copyFileSync

FileSystemManager.copyFile 的同步版本

tsx

(srcPath: string, destPath: string) => void

参数	类型	说明
srcPath	`string`	源文件路径，只可以是普通文件
destPath	`string`	目标文件路径

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.copyFileSync	✔️

getFileInfo

获取该小程序下的本地临时文件或本地缓存文件信息

tsx

(option: getFileInfoOption) => void

参数	类型
option	`getFileInfoOption`

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.getFileInfo	✔️

getSavedFileList

获取该小程序下已保存的本地缓存文件列表

tsx

(option?: getSavedFileListOption) => void

参数	类型
option	`getSavedFileListOption`

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.getSavedFileList	✔️

mkdir

创建目录

tsx

(option: MkdirOption) => void

参数	类型
option	`MkdirOption`

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.mkdir	✔️

mkdirSync

FileSystemManager.mkdir 的同步版本

tsx

(dirPath: string, recursive?: boolean) => void

参数	类型	说明
dirPath	`string`	创建的目录路径
recursive	`boolean`	是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在，则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true，将创建 a 目录，再在 a 目录下创建 b 目录，以此类推直至创建 a/b/c 目录下的 d 目录。

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.mkdirSync	✔️

readFile

读取本地文件内容

tsx

(option: ReadFileOption) => void

参数	类型
option	`ReadFileOption`

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.readFile	✔️

readdir

读取目录内文件列表

tsx

(option: ReaddirOption) => void

参数	类型
option	`ReaddirOption`

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.readdir	✔️

removeSavedFile

删除该小程序下已保存的本地缓存文件

tsx

(option: RemoveSavedFileOption) => void

参数	类型
option	`RemoveSavedFileOption`

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.removeSavedFile	✔️

rename

重命名文件。可以把文件从 oldPath 移动到 newPath

tsx

(option: RenameOption) => void

参数	类型
option	`RenameOption`

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.rename	✔️

renameSync

FileSystemManager.rename 的同步版本

tsx

(oldPath: string, newPath: string) => void

参数	类型	说明
oldPath	`string`	源文件路径，可以是普通文件或目录
newPath	`string`	新文件路径

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.renameSync	✔️

rmdir

删除目录

tsx

(option: RmdirOption) => void

参数	类型
option	`RmdirOption`

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.rmdir	✔️

rmdirSync

FileSystemManager.rmdir 的同步版本

tsx

(dirPath: string, recursive?: boolean) => void

参数	类型	说明
dirPath	`string`	要删除的目录路径
recursive	`boolean`	是否递归删除目录。如果为 true，则删除该目录和该目录下的所有子目录以及文件。

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.rmdirSync	✔️

saveFile

保存临时文件到本地。此接口会移动临时文件，因此调用成功后，tempFilePath 将不可用。

tsx

(option: SaveFileOption) => void

参数	类型
option	`SaveFileOption`

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.saveFile	✔️

stat

获取文件 Stats 对象

tsx

(option: StatOption) => void

参数	类型
option	`StatOption`

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.stat

unlink

删除文件

tsx

(option: UnlinkOption) => void

参数	类型
option	`UnlinkOption`

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.unlink	✔️

unlinkSync

FileSystemManager.unlink 的同步版本

tsx

(filePath: string) => void

参数	类型	说明
filePath	`string`	要删除的文件路径

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.unlinkSync	✔️

unzip

解压文件

tsx

(option: UnzipOption) => void

参数	类型
option	`UnzipOption`

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.unzip	✔️

writeFile

写文件

tsx

(option: WriteFileOption) => void

参数	类型
option	`WriteFileOption`

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.writeFile	✔️

writeFileSync

FileSystemManager.writeFile 的同步版本

tsx

(filePath: string, data: string | ArrayBuffer, encoding?: "ascii" | "base64" | "binary" | "hex" | "ucs2" | "ucs-2" | "utf16le" | "utf-16le" | "utf-8" | "utf8" | "latin1") => void

参数	类型	说明
filePath	`string`	要写入的文件路径
data	string or ArrayBuffer	要写入的文本或二进制数据
encoding	"ascii" or "base64" or "binary" or "hex" or "ucs2" or "ucs-2" or "utf16le" or "utf-16le" or "utf-8" or "utf8" or "latin1"	指定写入文件的字符编码

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.writeFileSync	✔️

statSync

FileSystemManager.stat 的同步版本

tsx

(path: string, recursive?: boolean) => Stats | Record<string, any>

参数	类型	说明
path	`string`	文件/目录路径
recursive	`boolean`	是否递归获取目录下的每个文件的 Stats 信息

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.statSync	✔️

saveFileSync

FileSystemManager.saveFile 的同步版本

tsx

(tempFilePath: string, filePath?: string) => number

参数	类型	说明
tempFilePath	`string`	临时存储文件路径
filePath	`string`	要存储的文件路径

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.saveFileSync	✔️

readFileSync

FileSystemManager.readFile 的同步版本

tsx

(filePath: string, encoding?: "ascii" | "base64" | "binary" | "hex" | "ucs2" | "ucs-2" | "utf16le" | "utf-16le" | "utf-8" | "utf8" | "latin1") => string | ArrayBuffer

参数	类型	说明
filePath	`string`	要读取的文件的路径
encoding	"ascii" or "base64" or "binary" or "hex" or "ucs2" or "ucs-2" or "utf16le" or "utf-16le" or "utf-8" or "utf8" or "latin1"	指定读取文件的字符编码，如果不传 encoding，则以 ArrayBuffer 格式读取文件的二进制内容

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.readFileSync	✔️

参数

encoding

字符编码

参数	说明
ascii
base64
binary
hex
ucs2	以小端序读取
ucs-2	以小端序读取
utf16le	以小端序读取
utf-16le	以小端序读取
utf-8
utf8
latin1

AccessOption

参数	类型	必填	说明
path	`string`	是	要判断是否存在的文件/目录路径
complete	`(res: CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: AccessFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: CallbackResult) => void`	否	接口调用成功的回调函数

AccessFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail no such file or directory ${path}': 文件/目录不存在;

AppendFileOption

参数	类型	必填	说明
data	string or ArrayBuffer	是	要追加的文本或二进制数据
filePath	`string`	是	要追加内容的文件路径
complete	`(res: CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
encoding	"ascii" or "base64" or "binary" or "hex" or "ucs2" or "ucs-2" or "utf16le" or "utf-16le" or "utf-8" or "utf8" or "latin1"	否	指定写入文件的字符编码
fail	`(result: AppendFileFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: CallbackResult) => void`	否	接口调用成功的回调函数

AppendFileFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail no such file or directory, open ${filePath}': 指定的 filePath 文件不存在;- 'fail illegal operation on a directory, open "${filePath}"': 指定的 filePath 是一个已经存在的目录;- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有写权限;- 'fail sdcard not mounted': 指定的 filePath 是一个已经存在的目录;

CopyFileOption

参数	类型	必填	说明
destPath	`string`	是	目标文件路径
srcPath	`string`	是	源文件路径，只可以是普通文件
complete	`(res: CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: CopyFileFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: CallbackResult) => void`	否	接口调用成功的回调函数

CopyFileFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail permission denied, copyFile ${srcPath} -> ${destPath}': 指定目标文件路径没有写权限;- 'fail no such file or directory, copyFile ${srcPath} -> ${destPath}': 源文件不存在，或目标文件路径的上层目录不存在;- 'fail the maximum size of the file storage limit is exceeded': 存储空间不足;

getFileInfoOption

参数	类型	必填	说明
filePath	`string`	是	要读取的文件路径
complete	`(res: CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: GetFileInfoFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(result: GetFileInfoSuccessCallbackResult) => void`	否	接口调用成功的回调函数

GetFileInfoFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail file not exist': 指定的 filePath 找不到文件;

GetFileInfoSuccessCallbackResult

参数	类型	说明
size	`number`	文件大小，以字节为单位
errMsg	`string`	调用结果

getSavedFileListOption

参数	类型	必填	说明
complete	`(res: CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(res: CallbackResult) => void`	否	接口调用失败的回调函数
success	`(result: GetSavedFileListSuccessCallbackResult) => void`	否	接口调用成功的回调函数

GetSavedFileListSuccessCallbackResult

参数	类型	说明
fileList	`GetSavedFileListSuccessCallbackResultFileItem[]`	文件数组
errMsg	`string`	调用结果

GetSavedFileListSuccessCallbackResultFileItem

文件数组

参数	类型	说明
createTime	`number`	文件保存时的时间戳，从1970/01/01 08:00:00 到当前时间的秒数
filePath	`string`	本地路径
size	`number`	本地文件大小，以字节为单位

MkdirOption

参数	类型	必填	说明
dirPath	`string`	是	创建的目录路径
complete	`(res: CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: MkdirFailCallbackResult) => void`	否	接口调用失败的回调函数
recursive	`boolean`	否	是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在，则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true，将创建 a 目录，再在 a 目录下创建 b 目录，以此类推直至创建 a/b/c 目录下的 d 目录。
success	`(res: CallbackResult) => void`	否	接口调用成功的回调函数

MkdirFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail no such file or directory ${dirPath}': 上级目录不存在;- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有写权限;- 'fail file already exists ${dirPath}': 有同名文件或目录;

ReadFileOption

参数	类型	必填	说明
filePath	`string`	是	要读取的文件的路径
complete	`(res: CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
encoding	"ascii" or "base64" or "binary" or "hex" or "ucs2" or "ucs-2" or "utf16le" or "utf-16le" or "utf-8" or "utf8" or "latin1"	否	指定读取文件的字符编码，如果不传 encoding，则以 ArrayBuffer 格式读取文件的二进制内容
fail	`(result: ReadFileFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: CallbackResult) => void`	否	接口调用成功的回调函数

ReadFileFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail no such file or directory, open ${filePath}': 指定的 filePath 所在目录不存在;- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有读权限;

ReaddirOption

参数	类型	必填	说明
dirPath	`string`	是	要读取的目录路径
complete	`(res: CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: ReaddirFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(result: ReaddirSuccessCallbackResult) => void`	否	接口调用成功的回调函数

ReaddirFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail no such file or directory ${dirPath}': 目录不存在;- 'fail not a directory ${dirPath}': dirPath 不是目录;- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有读权限;

ReaddirSuccessCallbackResult

参数	类型	说明
files	`string[]`	指定目录下的文件名数组。
errMsg	`string`	调用结果

RemoveSavedFileOption

参数	类型	必填	说明
filePath	`string`	是	需要删除的文件路径
complete	`(res: CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: RemoveSavedFileFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: CallbackResult) => void`	否	接口调用成功的回调函数

RemoveSavedFileFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail file not exist': 指定的 tempFilePath 找不到文件;

RenameOption

参数	类型	必填	说明
newPath	`string`	是	新文件路径
oldPath	`string`	是	源文件路径，可以是普通文件或目录
complete	`(res: CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: RenameFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: CallbackResult) => void`	否	接口调用成功的回调函数

RenameFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail permission denied, rename ${oldPath} -> ${newPath}': 指定源文件或目标文件没有写权限;- 'fail no such file or directory, rename ${oldPath} -> ${newPath}': 源文件不存在，或目标文件路径的上层目录不存在;

RmdirOption

参数	类型	必填	说明
dirPath	`string`	是	要删除的目录路径
complete	`(res: CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: RmdirFailCallbackResult) => void`	否	接口调用失败的回调函数
recursive	`boolean`	否	是否递归删除目录。如果为 true，则删除该目录和该目录下的所有子目录以及文件。
success	`(res: CallbackResult) => void`	否	接口调用成功的回调函数

RmdirFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail no such file or directory ${dirPath}': 目录不存在;- 'fail directory not empty': 目录不为空;- 'fail permission denied, open ${dirPath}': 指定的 dirPath 路径没有写权限;

SaveFileOption

参数	类型	必填	说明
tempFilePath	`string`	是	临时存储文件路径
complete	`(res: CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: SaveFileFailCallbackResult) => void`	否	接口调用失败的回调函数
filePath	`string`	否	要存储的文件路径
success	`(result: SaveFileSuccessCallbackResult) => void`	否	接口调用成功的回调函数

SaveFileFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail tempFilePath file not exist': 指定的 tempFilePath 找不到文件;- 'fail permission denied, open "${filePath}"': 指定的 filePath 路径没有写权限;- 'fail no such file or directory "${dirPath}"': 上级目录不存在;- 'fail the maximum size of the file storage limit is exceeded': 存储空间不足;

SaveFileSuccessCallbackResult

参数	类型	说明
savedFilePath	`number`	存储后的文件路径
errMsg	`string`	调用结果

StatOption

参数	类型	必填	说明
path	`string`	是	文件/目录路径
complete	`(res: CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: StatFailCallbackResult) => void`	否	接口调用失败的回调函数
recursive	`boolean`	否	是否递归获取目录下的每个文件的 Stats 信息
success	`(result: StatSuccessCallbackResult) => void`	否	接口调用成功的回调函数

StatFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail permission denied, open ${path}': 指定的 path 路径没有读权限;- 'fail no such file or directory ${path}': 文件不存在;

StatSuccessCallbackResult

参数	类型	说明
stats	Stats or Record<string, any>	StatsorObject当 recursive 为 false 时，res.stats 是一个 Stats 对象。当 recursive 为 true 且 path 是一个目录的路径时，res.stats 是一个 Object，key 以 path 为根路径的相对路径，value 是该路径对应的 Stats 对象。
errMsg	`string`	调用结果

UnlinkOption

参数	类型	必填	说明
filePath	`string`	是	要删除的文件路径
complete	`(res: CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: UnlinkFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: CallbackResult) => void`	否	接口调用成功的回调函数

UnlinkFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail permission denied, open ${path}': 指定的 path 路径没有读权限;- 'fail no such file or directory ${path}': 文件不存在;- 'fail operation not permitted, unlink ${filePath}': 传入的 filePath 是一个目录;

UnzipOption

参数	类型	必填	说明
targetPath	`string`	是	目标目录路径
zipFilePath	`string`	是	源文件路径，只可以是 zip 压缩文件
complete	`(res: CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: UnzipFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: CallbackResult) => void`	否	接口调用成功的回调函数

UnzipFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail permission denied, unzip ${zipFilePath} -> ${destPath}': 指定目标文件路径没有写权限;- 'fail no such file or directory, unzip ${zipFilePath} -> "${destPath}': 源文件不存在，或目标文件路径的上层目录不存在;

WriteFileOption

参数	类型	必填	说明
data	string or ArrayBuffer	是	要写入的文本或二进制数据
filePath	`string`	是	要写入的文件路径
complete	`(res: CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
encoding	"ascii" or "base64" or "binary" or "hex" or "ucs2" or "ucs-2" or "utf16le" or "utf-16le" or "utf-8" or "utf8" or "latin1"	否	指定写入文件的字符编码
fail	`(result: WriteFileFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: CallbackResult) => void`	否	接口调用成功的回调函数

WriteFileFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail no such file or directory, open ${filePath}': 指定的 filePath 所在目录不存在;- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有写权限;- 'fail the maximum size of the file storage limit is exceeded': 存储空间不足;

API 支持度

API	微信小程序	H5	React Native
FileSystemManager.readdirSync	✔️
FileSystemManager.access	✔️
FileSystemManager.accessSync	✔️
FileSystemManager.appendFile	✔️
FileSystemManager.appendFileSync	✔️
FileSystemManager.copyFile	✔️
FileSystemManager.copyFileSync	✔️
FileSystemManager.getFileInfo	✔️
FileSystemManager.getSavedFileList	✔️
FileSystemManager.mkdir	✔️
FileSystemManager.mkdirSync	✔️
FileSystemManager.readFile	✔️
FileSystemManager.readdir	✔️
FileSystemManager.removeSavedFile	✔️
FileSystemManager.rename	✔️
FileSystemManager.renameSync	✔️
FileSystemManager.rmdir	✔️
FileSystemManager.rmdirSync	✔️
FileSystemManager.saveFile	✔️
FileSystemManager.stat
FileSystemManager.unlink	✔️
FileSystemManager.unlinkSync	✔️
FileSystemManager.unzip	✔️
FileSystemManager.writeFile	✔️
FileSystemManager.writeFileSync	✔️
FileSystemManager.statSync	✔️
FileSystemManager.saveFileSync	✔️
FileSystemManager.readFileSync	✔️

File: docs/apis/files/getFileInfo.md

获取该小程序下的本地临时文件或本地缓存文件信息

类型

tsx

(option: Option) => Promise<SuccessCallbackResult | FailCallbackResult>

参数

Option

参数	类型	必填	说明
filePath	`string`	是	要读取的文件路径
complete	`(res: CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: FailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(result: SuccessCallbackResult) => void`	否	接口调用成功的回调函数

FailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail file not exist': 指定的 filePath 找不到文件;

SuccessCallbackResult

参数	类型	说明
size	`number`	文件大小，以字节为单位
errMsg	`string`	调用结果

示例代码

tsx

Taro.getFileInfo({
    success: function (res) {
        console.log(res.size)
        console.log(res.digest)
    }
})

API 支持度

API	微信小程序	H5	React Native
Taro.getFileInfo	✔️

File: docs/apis/files/getFileSystemManager.md

获取全局唯一的文件管理器

类型

tsx

() => FileSystemManager

参数

API 支持度

API	微信小程序	H5	React Native
Taro.getFileSystemManager	✔️

File: docs/apis/files/getSavedFileInfo.md

获取本地文件的文件信息。此接口只能用于获取已保存到本地的文件，若需要获取临时文件信息，请使用 Taro.getFileInfo 接口。

类型

tsx

(option: Option) => Promise<SuccessCallbackResult>

参数

Option

参数	类型	必填	说明
filePath	`string`	是	文件路径
complete	`(res: CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(res: CallbackResult) => void`	否	接口调用失败的回调函数
success	`(result: SuccessCallbackResult) => void`	否	接口调用成功的回调函数

SuccessCallbackResult

参数	类型	说明
createTime	`number`	文件保存时的时间戳，从1970/01/01 08:00:00 到该时刻的秒数
size	`number`	文件大小，单位 B
errMsg	`string`	调用结果

示例代码

tsx

Taro.getSavedFileInfo({
  filePath: 'wxfile://somefile', //仅做示例用，非真正的文件路径
  success: function (res) {
    console.log(res.size)
    console.log(res.createTime)
  }
})

API 支持度

API	微信小程序	H5	React Native
Taro.getSavedFileInfo	✔️

File: docs/apis/files/getSavedFileList.md

获取本地已保存的文件列表

类型

tsx

(option?: Option) => Promise<SuccessCallbackResult>

参数

Option

参数	类型	必填	说明
complete	`(res: CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(res: CallbackResult) => void`	否	接口调用失败的回调函数
success	`(result: SuccessCallbackResult) => void`	否	接口调用成功的回调函数

SuccessCallbackResult

参数	类型	说明
fileList	`FileItem[]`	文件数组
errMsg	`string`	调用结果

FileItem

文件数组

参数	类型	说明
createTime	`number`	文件保存时的时间戳，从1970/01/01 08:00:00 到当前时间的秒数
filePath	`string`	本地路径
size	`number`	本地文件大小，以字节为单位

示例代码

tsx

Taro.getSavedFileList({
  success: function (res) {
    console.log(res.fileList)
  }
})

API 支持度

API	微信小程序	H5	React Native
Taro.getSavedFileList	✔️

2. Official Technical Reference & Guides (NervJS/taro-docs)

File: README.md

Taro 文档

bash

.
├── LICENSE
├── README.md
├── blog # 博客
├── docs # 最新版本文档
├── docusaurus.config.js
├── node_modules
├── package.json
├── sidebars.js # 最新版本文档导航
├── src # 文档主题
├── static # 静态文件
├── tsconfig.json
├── versioned_docs # 版本文档
├── versioned_sidebars # 版本文档导航
├── versions.json
└── pnpm-lock.yaml

开发流程

从最新版本的 master 分支新建一个分支：git checkout -b docs/fix-something
提交新建的分支发起 Pull Request
在 Pull Request 页面中如果编译成功，则会自动部署一个预览站点
预览站点确认修改无误后 Merge 到 master 分支，则会自动部署到 GitHub Pages 和 docs.taro.zone

修改文档

v1 或 v2

修改 versioned_docs 和 versioned_sidebars 对应的文件。

v3

修改 docs 和 sidebars.js 对应的文件。

升级文档

v1 或 v2

v1 或 v2 不升级版本，直接修改 versioned_docs 和 versioned_sidebars 对应的文件。

v3

运行命令：pnpm run docusaurus docs:version <semver>

File: docs/apis/framework/App.md

注册小程序。接受一个 Object 参数，其指定小程序的生命周期回调等。

方法

File: docs/apis/framework/getApp.md

获取到小程序全局唯一的 App 实例。

支持情况：

类型

tsx

<T = TaroGeneral.IAnyObject>(opts?: Option) => Instance<T>

参数

参数	类型
opts	`T`

Option

参数	类型	必填	说明
allowDefault	`boolean`	否	在 `App` 未定义时返回默认实现。当App被调用时，默认实现中定义的属性会被覆盖合并到App中。一般用于独立分包

Instance

tsx

Option | T

File: docs/apis/framework/getCurrentPages.md

获取当前页面栈。数组中第一个元素为首页，最后一个元素为当前页面。
注意：

不要尝试修改页面栈，会导致路由以及页面状态错误。
不要在 App.onLaunch 的时候调用 getCurrentPages()，此时 page 还没有生成。

支持情况：

类型

tsx

() => Page[]

示例代码

tsx

Taro.getCurrentPages().length

File: docs/apis/framework/Page.md

注册小程序中的一个页面。接受一个 Object 类型参数，其指定页面的初始数据、生命周期回调、事件处理函数等。

方法

参数	类型	必填	说明
route	`string`	否	当前页面的路径note: 推荐使用 Taro.getCurrentInstance().router?.path 方法
route	`string`	否

File: docs/apis/files/FileSystemManager.md

文件管理器，可通过 Taro.getFileSystemManager 获取。

支持情况：

方法

access

判断文件/目录是否存在

支持情况：

tsx

(option: AccessOption) => void

参数	类型
option	`AccessOption`

accessSync

FileSystemManager.access 的同步版本

支持情况：

tsx

(path: string) => void

参数	类型	说明
path	`string`	要判断是否存在的文件/目录路径

appendFile

在文件结尾追加内容

支持情况：

tsx

(option: AppendFileOption) => void

参数	类型
option	`AppendFileOption`

appendFileSync

FileSystemManager.appendFile 的同步版本

支持情况：

tsx

(filePath: string, data: string | ArrayBuffer, encoding?: keyof Encoding) => void

参数	类型	说明
filePath	`string`	要追加内容的文件路径
data	string or ArrayBuffer	要追加的文本或二进制数据
encoding	`keyof Encoding`	指定写入文件的字符编码

close

关闭文件

支持情况：

tsx

(option: CloseOption) => void

参数	类型
option	`CloseOption`

closeSync

FileSystemManager.close 的同步版本

支持情况：

tsx

(option: CloseSyncOption) => void

参数	类型
option	`CloseSyncOption`

copyFile

复制文件

支持情况：

tsx

(option: CopyFileOption) => void

参数	类型
option	`CopyFileOption`

copyFileSync

FileSystemManager.copyFile 的同步版本

支持情况：

tsx

(srcPath: string, destPath: string) => void

参数	类型	说明
srcPath	`string`	源文件路径，只可以是普通文件
destPath	`string`	目标文件路径

fstat

获取文件的状态信息

支持情况：

tsx

(option: FstatOption) => void

参数	类型
option	`FstatOption`

fstatSync

FileSystemManager.fstat 的同步版本

支持情况：

tsx

(option: FstatSyncOption) => Stats

参数	类型
option	`FstatSyncOption`

ftruncate

对文件内容进行截断操作

支持情况：

tsx

(option: FtruncateOption) => void

参数	类型
option	`FtruncateOption`

ftruncateSync

FileSystemManager.ftruncate 的同步版本

支持情况：

tsx

(option: FtruncateSyncOption) => void

参数	类型
option	`FtruncateSyncOption`

getFileInfo

获取该小程序下的 本地临时文件 或 本地缓存文件 信息

支持情况：

tsx

(option: getFileInfoOption) => void

参数	类型
option	`getFileInfoOption`

getSavedFileList

获取该小程序下已保存的本地缓存文件列表

支持情况：

tsx

(option?: getSavedFileListOption) => void

参数	类型
option	`getSavedFileListOption`

mkdir

创建目录

支持情况：

tsx

(option: MkdirOption) => void

参数	类型
option	`MkdirOption`

mkdirSync

FileSystemManager.mkdir 的同步版本

支持情况：

tsx

(dirPath: string, recursive?: boolean) => void

参数	类型	说明
dirPath	`string`	创建的目录路径
recursive	`boolean`	是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在，则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true，将创建 a 目录，再在 a 目录下创建 b 目录，以此类推直至创建 a/b/c 目录下的 d 目录。

open

打开文件，返回文件描述符

支持情况：

tsx

(option: OpenOption) => void

参数	类型
option	`OpenOption`

openSync

FileSystemManager.openSync 的同步版本

支持情况：

tsx

(option: OpenSyncOption) => string

参数	类型
option	`OpenSyncOption`

read

读文件

支持情况：

tsx

(option: ReadOption) => void

参数	类型
option	`ReadOption`

readCompressedFile

读取指定压缩类型的本地文件内容

支持情况：

tsx

(option: Option) => Promise

参数	类型
option	`Option`

readCompressedFileSync

同步读取指定压缩类型的本地文件内容

支持情况：

tsx

(option: Option) => ArrayBuffer

参数	类型
option	`Option`

readdir

读取目录内文件列表

支持情况：

tsx

(option: ReaddirOption) => void

参数	类型
option	`ReaddirOption`

readdirSync

FileSystemManager.readdir 的同步版本

支持情况：

tsx

(dirPath: string) => string[]

参数	类型	说明
dirPath	`string`	要读取的目录路径

readFile

读取本地文件内容

支持情况：

tsx

(option: ReadFileOption) => void

参数	类型
option	`ReadFileOption`

readFileSync

FileSystemManager.readFile 的同步版本

支持情况：

tsx

(filePath: string, encoding?: keyof Encoding, position?: number, length?: number) => string | ArrayBuffer

参数	类型	说明
filePath	`string`	要读取的文件的路径
encoding	`keyof Encoding`	指定读取文件的字符编码，如果不传 encoding，则以 ArrayBuffer 格式读取文件的二进制内容
position	`number`	从文件指定位置开始读，如果不指定，则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围：[0, fileLength - 1]。单位：byte
length	`number`	指定文件的长度，如果不指定，则读到文件末尾。有效范围：[1, fileLength]。单位：byte

readSync

FileSystemManager.read 的同步版本

支持情况：

tsx

(option: ReadSyncOption) => { bytesRead: number; arrayBuffer: ArrayBuffer; }

参数	类型
option	`ReadSyncOption`

readZipEntry

读取压缩包内的文件

支持情况：

tsx

(option: Option) => Promise

参数	类型
option	`Option`

removeSavedFile

删除该小程序下已保存的本地缓存文件

支持情况：

tsx

(option: RemoveSavedFileOption) => void

参数	类型
option	`RemoveSavedFileOption`

rename

重命名文件。可以把文件从 oldPath 移动到 newPath

支持情况：

tsx

(option: RenameOption) => void

参数	类型
option	`RenameOption`

renameSync

FileSystemManager.rename 的同步版本

支持情况：

tsx

(oldPath: string, newPath: string) => void

参数	类型	说明
oldPath	`string`	源文件路径，可以是普通文件或目录
newPath	`string`	新文件路径

rmdir

删除目录

支持情况：

tsx

(option: RmdirOption) => void

参数	类型
option	`RmdirOption`

rmdirSync

FileSystemManager.rmdir 的同步版本

支持情况：

tsx

(dirPath: string, recursive?: boolean) => void

参数	类型	说明
dirPath	`string`	要删除的目录路径
recursive	`boolean`	是否递归删除目录。如果为 true，则删除该目录和该目录下的所有子目录以及文件。

saveFile

保存临时文件到本地。此接口会移动临时文件，因此调用成功后，tempFilePath 将不可用。

支持情况：

tsx

(option: SaveFileOption) => void

参数	类型
option	`SaveFileOption`

saveFileSync

FileSystemManager.saveFile 的同步版本

支持情况：

tsx

(tempFilePath: string, filePath?: string) => string

参数	类型	说明
tempFilePath	`string`	临时存储文件路径
filePath	`string`	要存储的文件路径

stat

获取文件 Stats 对象

支持情况：

tsx

(option: StatOption) => void

参数	类型
option	`StatOption`

statSync

FileSystemManager.stat 的同步版本

支持情况：

tsx

(path: string, recursive?: boolean) => any

参数	类型	说明
path	`string`	文件/目录路径
recursive	`boolean`	是否递归获取目录下的每个文件的 Stats 信息

truncate

对文件内容进行截断操作

支持情况：

tsx

(option: TruncateOption) => void

参数	类型
option	`TruncateOption`

truncateSync

对文件内容进行截断操作 (truncate 的同步版本)

支持情况：

tsx

(option: TruncateSyncOption) => void

参数	类型
option	`TruncateSyncOption`

unlink

删除文件

支持情况：

tsx

(option: UnlinkOption) => void

参数	类型
option	`UnlinkOption`

unlinkSync

FileSystemManager.unlink 的同步版本

支持情况：

tsx

(filePath: string) => void

参数	类型	说明
filePath	`string`	要删除的文件路径

unzip

解压文件

支持情况：

tsx

(option: UnzipOption) => void

参数	类型
option	`UnzipOption`

write

写入文件

支持情况：

tsx

(option: WriteOption) => void

参数	类型
option	`WriteOption`

writeFile

写文件

支持情况：

tsx

(option: WriteFileOption) => void

参数	类型
option	`WriteFileOption`

writeFileSync

FileSystemManager.writeFile 的同步版本

支持情况：

tsx

(filePath: string, data: string | ArrayBuffer, encoding?: keyof Encoding) => void

参数	类型	说明
filePath	`string`	要写入的文件路径
data	string or ArrayBuffer	要写入的文本或二进制数据
encoding	`keyof Encoding`	指定写入文件的字符编码

writeSync

write 的同步版本

支持情况：

tsx

(option: WriteSyncOption) => { bytesWritten: number; }

参数	类型
option	`WriteSyncOption`

参数

Encoding

字符编码

参数	说明
ascii
base64
binary
hex
ucs2	以小端序读取
ucs-2	以小端序读取
utf16le	以小端序读取
utf-16le	以小端序读取
utf-8
utf8
latin1

flag

文件系统标志

AccessOption

参数	类型	必填	说明
path	`string`	是	要判断是否存在的文件/目录路径
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: AccessFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用成功的回调函数

AccessFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail no such file or directory ${path}': 文件/目录不存在;

AppendFileOption

参数	类型	必填	说明
data	string or ArrayBuffer	是	要追加的文本或二进制数据
filePath	`string`	是	要追加内容的文件路径
encoding	`keyof Encoding`	否	指定写入文件的字符编码
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: AppendFileFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用成功的回调函数

AppendFileFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail no such file or directory, open ${filePath}': 指定的 filePath 文件不存在;- 'fail illegal operation on a directory, open "${filePath}"': 指定的 filePath 是一个已经存在的目录;- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有写权限;- 'fail sdcard not mounted': 指定的 filePath 是一个已经存在的目录;

CopyFileOption

参数	类型	必填	说明
destPath	`string`	是	目标文件路径
srcPath	`string`	是	源文件路径，只可以是普通文件
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: CopyFileFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用成功的回调函数

CopyFileFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail permission denied, copyFile ${srcPath} -> ${destPath}': 指定目标文件路径没有写权限;- 'fail no such file or directory, copyFile ${srcPath} -> ${destPath}': 源文件不存在，或目标文件路径的上层目录不存在;- 'fail the maximum size of the file storage limit is exceeded': 存储空间不足;

getFileInfoOption

参数	类型	默认值	必填	说明
filePath	`string`		是	要读取的文件路径
digestAlgorithm	"md5" or "sha1"	`'md5'`	否	计算文件摘要的算法
complete	`(res: TaroGeneral.CallbackResult) => void`		否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: GetFileInfoFailCallbackResult) => void`		否	接口调用失败的回调函数
success	`(result: GetFileInfoSuccessCallbackResult) => void`		否	接口调用成功的回调函数

GetFileInfoFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail file not exist': 指定的 filePath 找不到文件;

GetFileInfoSuccessCallbackResult

参数	类型	必填	说明
size	`number`	是	文件大小，以字节为单位
digest	`string`	否	按照传入的 digestAlgorithm 计算得出的的文件摘要
errMsg	`string`	是	调用结果

getSavedFileListOption

参数	类型	必填	说明
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用失败的回调函数
success	`(result: GetSavedFileListSuccessCallbackResult) => void`	否	接口调用成功的回调函数

GetSavedFileListSuccessCallbackResult

参数	类型	说明
fileList	`GetSavedFileListSuccessCallbackResultFileItem[]`	文件数组
errMsg	`string`	调用结果

GetSavedFileListSuccessCallbackResultFileItem

文件数组

参数	类型	说明
createTime	`number`	文件保存时的时间戳，从1970/01/01 08:00:00 到当前时间的秒数
filePath	`string`	本地路径
size	`number`	本地文件大小，以字节为单位

MkdirOption

参数	类型	默认值	必填	说明
dirPath	`string`		是	创建的目录路径
recursive	`boolean`	`false`	否	是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在，则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true，将创建 a 目录，再在 a 目录下创建 b 目录，以此类推直至创建 a/b/c 目录下的 d 目录。
complete	`(res: TaroGeneral.CallbackResult) => void`		否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: MkdirFailCallbackResult) => void`		否	接口调用失败的回调函数
success	`(res: TaroGeneral.CallbackResult) => void`		否	接口调用成功的回调函数

MkdirFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail no such file or directory ${dirPath}': 上级目录不存在;- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有写权限;- 'fail file already exists ${dirPath}': 有同名文件或目录;

ReadFileOption

参数	类型	必填	说明
filePath	`string`	是	要读取的文件的路径
position	`number`	否	从文件指定位置开始读，如果不指定，则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围：[0, fileLength - 1]。单位：byte
length	`number`	否	指定文件的长度，如果不指定，则读到文件末尾。有效范围：[1, fileLength]。单位：byte
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
encoding	`keyof Encoding`	否	指定读取文件的字符编码，如果不传 encoding，则以 ArrayBuffer 格式读取文件的二进制内容
fail	`(result: ReadFileFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: ReadFileSuccessCallbackResult) => void`	否	接口调用成功的回调函数

ReadFileSuccessCallbackResult

参数	类型	说明
data	string or ArrayBuffer	文件内容
errMsg	`string`	调用结果

ReadFileFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail no such file or directory, open ${filePath}': 指定的 filePath 所在目录不存在;- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有读权限;

ReaddirOption

参数	类型	必填	说明
dirPath	`string`	是	要读取的目录路径
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: ReaddirFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(result: ReaddirSuccessCallbackResult) => void`	否	接口调用成功的回调函数

ReaddirFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail no such file or directory ${dirPath}': 目录不存在;- 'fail not a directory ${dirPath}': dirPath 不是目录;- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有读权限;

ReaddirSuccessCallbackResult

参数	类型	说明
files	`string[]`	指定目录下的文件名数组。
errMsg	`string`	调用结果

readZipEntry

Promised

tsx

FailCallbackResult | SuccessCallbackResult

Option

参数	类型	必填	说明
filePath	`string`	是	要读取的压缩包的路径 (本地路径)
encoding	`string`	否	统一指定读取文件的字符编码，只在 entries 值为"all"时有效。如果 entries 值为"all"且不传 encoding，则以 ArrayBuffer 格式读取文件的二进制内容
entries	File[] or "all"	是	要读取的压缩包内的文件列表（当传入"all" 时表示读取压缩包内所有文件）
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: FailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: SuccessCallbackResult) => void`	否	接口调用成功的回调函数

File

参数	类型	必填	说明
path	`string`	是	压缩包内文件路径
encoding	`string`	否	指定读取文件的字符编码，如果不传 encoding，则以 ArrayBuffer 格式读取文件的二进制内容
position	`number`	否	从文件指定位置开始读，如果不指定，则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围：[0, fileLength - 1]。单位：byte
length	`number`	否	指定文件的长度，如果不指定，则读到文件末尾。有效范围：[1, fileLength]。单位：byte

Encoding

字符编码合法值

参数	异常情况
ascii
base64
binary
hex
ucs2	`以小端序读取`
ucs-2	`以小端序读取`
utf16le	`以小端序读取`
utf-16le	`以小端序读取`
utf-8
utf8
latin1

FailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail no such file or directory, open ${filePath}': 指定的 filePath 所在目录不存在- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有读权限- 'fail sdcard not mounted': Android sdcard 挂载失败

SuccessCallbackResult

参数	类型	说明
entries	`{ [path: string]: FileItem; }`	文件读取结果。res.entries 是一个对象，key是文件路径，value是一个对象 FileItem ，表示该文件的读取结果。每个 FileItem 包含 data （文件内容）和 errMsg （错误信息）属性。

FileItem

参数	类型	说明
data	string or ArrayBuffer	文件内容
errMsg	`string`	错误信息

RemoveSavedFileOption

参数	类型	必填	说明
filePath	`string`	是	需要删除的文件路径
apFilePath	`string`	否	本地缓存文件路径API 支持度: alipay
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: RemoveSavedFileFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用成功的回调函数

RemoveSavedFileFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail file not exist': 指定的 tempFilePath 找不到文件;

RenameOption

参数	类型	必填	说明
newPath	`string`	是	新文件路径
oldPath	`string`	是	源文件路径，可以是普通文件或目录
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: RenameFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用成功的回调函数

RenameFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail permission denied, rename ${oldPath} -> ${newPath}': 指定源文件或目标文件没有写权限;- 'fail no such file or directory, rename ${oldPath} -> ${newPath}': 源文件不存在，或目标文件路径的上层目录不存在;

RmdirOption

参数	类型	必填	说明
dirPath	`string`	是	要删除的目录路径
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: RmdirFailCallbackResult) => void`	否	接口调用失败的回调函数
recursive	`boolean`	否	是否递归删除目录。如果为 true，则删除该目录和该目录下的所有子目录以及文件。
success	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用成功的回调函数

RmdirFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail no such file or directory ${dirPath}': 目录不存在;- 'fail directory not empty': 目录不为空;- 'fail permission denied, open ${dirPath}': 指定的 dirPath 路径没有写权限;

SaveFileOption

参数	类型	必填	说明
tempFilePath	`string`	是	临时存储文件路径
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: SaveFileFailCallbackResult) => void`	否	接口调用失败的回调函数
filePath	`string`	否	要存储的文件路径
success	`(result: SaveFileSuccessCallbackResult) => void`	否	接口调用成功的回调函数

SaveFileFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail tempFilePath file not exist': 指定的 tempFilePath 找不到文件;- 'fail permission denied, open "${filePath}"': 指定的 filePath 路径没有写权限;- 'fail no such file or directory "${dirPath}"': 上级目录不存在;- 'fail the maximum size of the file storage limit is exceeded': 存储空间不足;

SaveFileSuccessCallbackResult

参数	类型	说明
savedFilePath	`string`	存储后的文件路径
errMsg	`string`	调用结果

StatOption

参数	类型	必填	说明
path	`string`	是	文件/目录路径
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: StatFailCallbackResult) => void`	否	接口调用失败的回调函数
recursive	`boolean`	否	是否递归获取目录下的每个文件的 Stats 信息
success	`(result: StatSuccessCallbackResult) => void`	否	接口调用成功的回调函数

StatFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail permission denied, open ${path}': 指定的 path 路径没有读权限;- 'fail no such file or directory ${path}': 文件不存在;

StatSuccessCallbackResult

参数	类型	说明
stats	`any`	Stats or Object当 recursive 为 false 时，res.stats 是一个 Stats 对象。当 recursive 为 true 且 path 是一个目录的路径时，res.stats 是一个 Object，key 以 path 为根路径的相对路径，value 是该路径对应的 Stats 对象。
errMsg	`string`	调用结果

UnlinkOption

参数	类型	必填	说明
filePath	`string`	是	要删除的文件路径
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: UnlinkFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用成功的回调函数

UnlinkFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail permission denied, open ${path}': 指定的 path 路径没有读权限;- 'fail no such file or directory ${path}': 文件不存在;- 'fail operation not permitted, unlink ${filePath}': 传入的 filePath 是一个目录;

UnzipOption

参数	类型	必填	说明
targetPath	`string`	是	目标目录路径
zipFilePath	`string`	是	源文件路径，只可以是 zip 压缩文件
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: UnzipFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用成功的回调函数

UnzipFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail permission denied, unzip ${zipFilePath} -> ${destPath}': 指定目标文件路径没有写权限;- 'fail no such file or directory, unzip ${zipFilePath} -> "${destPath}': 源文件不存在，或目标文件路径的上层目录不存在;

WriteFileOption

参数	类型	必填	说明
data	string or ArrayBuffer	是	要写入的文本或二进制数据
filePath	`string`	是	要写入的文件路径
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
encoding	`keyof Encoding`	否	指定写入文件的字符编码
fail	`(result: WriteFileFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用成功的回调函数

WriteFileFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail no such file or directory, open ${filePath}': 指定的 filePath 所在目录不存在;- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有写权限;- 'fail the maximum size of the file storage limit is exceeded': 存储空间不足;

FstatOption

参数	类型	必填	说明
fd	`string`	是	文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: FstatFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: FstatSuccessCallbackResult) => void`	否	接口调用成功的回调函数

FstatFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'bad file descriptor': 无效的文件描述符;- 'fail permission denied': 指定的 fd 路径没有读权限;

FstatSuccessCallbackResult

参数	类型	说明
stats	`Stats`	Stats 对象，包含了文件的状态信息
errMsg	`string`	调用结果

FstatSyncOption

参数	类型	说明
fd	`string`	文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得

CloseOption

参数	类型	必填	说明
fd	`string`	是	需要被关闭的文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: CloseFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用成功的回调函数

CloseFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'bad file descriptor': 无效的文件描述符

CloseSyncOption

参数	类型	说明
fd	`string`	需要被关闭的文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得

FtruncateOption

参数	类型	必填	说明
fd	`string`	是	文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得
length	`number`	是	截断位置，默认0。如果 length 小于文件长度（单位：字节），则只有前面 length 个字节会保留在文件中，其余内容会被删除；如果 length 大于文件长度，则会对其进行扩展，并且扩展部分将填充空字节（'\0'）
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: FtruncateFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用成功的回调函数

FtruncateFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'bad file descriptor': 无效的文件描述符- 'fail permission denied': 指定的 fd 没有写权限- 'fail the maximum size of the file storage limit is exceeded': 存储空间不足- 'fail sdcard not mounted android sdcard': 挂载失败

FtruncateSyncOption

参数	类型	说明
fd	`string`	文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得
length	`number`	截断位置，默认0。如果 length 小于文件长度（单位：字节），则只有前面 length 个字节会保留在文件中，其余内容会被删除；如果 length 大于文件长度，则会对其进行扩展，并且扩展部分将填充空字节（'\0'）

OpenOption

参数	类型	必填	说明
filePath	`string`	是	文件路径 (本地路径)
flag	`keyof flag`	否	文件系统标志，默认值: 'r'
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: OpenFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: OpenSuccessCallbackResult) => void`	否	接口调用成功的回调函数

OpenFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail no such file or directory "${filePath}"': 上级目录不存在

OpenSuccessCallbackResult

参数	类型	说明
fd	`string`	文件描述符
errMsg	`string`	调用结果

OpenSyncOption

参数	类型	必填	说明
filePath	`string`	是	文件路径 (本地路径)
flag	`keyof flag`	否	文件系统标志，默认值: 'r'

ReadOption

参数	类型	必填	说明
fd	`string`	是	文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得
arrayBuffer	`ArrayBuffer`	是	数据写入的缓冲区，必须是 ArrayBuffer 实例
offset	`number`	否	缓冲区中的写入偏移量，默认0
length	`number`	否	要从文件中读取的字节数，默认0
position	`number`	否	文件读取的起始位置，如不传或传 null，则会从当前文件指针的位置读取。如果 position 是正整数，则文件指针位置会保持不变并从 position 读取文件。
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: ReadFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: ReadSuccessCallbackResult) => void`	否	接口调用成功的回调函数

ReadFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'bad file descriptor': 无效的文件描述符- 'fail permission denied': 指定的 fd 路径没有读权限- 'fail the value of "offset" is out of range': 传入的 offset 不合法- 'fail the value of "length" is out of range': 传入的 length 不合法- 'fail sdcard not mounted': android sdcard 挂载失败- 'bad file descriptor': 无效的文件描述符

ReadSuccessCallbackResult

参数	类型	说明
bytesRead	`string`	实际读取的字节数
arrayBuffer	`ArrayBuffer`	被写入的缓存区的对象，即接口入参的 arrayBuffer
errMsg	`string`	调用结果

readCompressedFile

Promised

tsx

FailCallbackResult | SuccessCallbackResult

Option

参数	类型	必填	说明
filePath	`string`	是	要读取的文件的路径 (本地用户文件或代码包文件)
compressionAlgorithm	`string`	是	文件压缩类型，目前仅支持 'br'。
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: FailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: SuccessCallbackResult) => void`	否	接口调用成功的回调函数

CompressionAlgorithm

文件压缩类型合法值

参数	说明
br	brotli压缩文件

FailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail decompress fail': 指定的 compressionAlgorithm 与文件实际压缩格式不符- 'fail no such file or directory, open ${filePath}': 指定的 filePath 所在目录不存在- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有读权限

SuccessCallbackResult

参数	类型	说明
data	`ArrayBuffer`	文件内容

readCompressedFileSync

Option

参数	类型	说明
filePath	`string`	要读取的文件的路径 (本地用户文件或代码包文件)
compressionAlgorithm	`string`	文件压缩类型，目前仅支持 'br'。

CompressionAlgorithm

文件压缩类型合法值

参数	说明
br	brotli压缩文件

ReadSyncOption

参数	类型	必填	说明
fd	`string`	是	文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得
arrayBuffer	`ArrayBuffer`	是	数据写入的缓冲区，必须是 ArrayBuffer 实例
offset	`number`	否	缓冲区中的写入偏移量，默认0
length	`number`	否	要从文件中读取的字节数，默认0
position	`number`	否	文件读取的起始位置，如不传或传 null，则会从当前文件指针的位置读取。如果 position 是正整数，则文件指针位置会保持不变并从 position 读取文件。

TruncateOption

参数	类型	必填	说明
filePath	`string`	是	要截断的文件路径 (本地路径)
length	`number`	否	截断位置，默认0。如果 length 小于文件长度（字节），则只有前面 length 个字节会保留在文件中，其余内容会被删除；如果 length 大于文件长度，则会对其进行扩展，并且扩展部分将填充空字节（'\0'）
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: TruncateFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用成功的回调函数

TruncateFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail no such file or directory, open ${filePath}': 指定的 filePath 所在目录不存在- 'fail illegal operation on a directory, open "${filePath}"': 指定的 filePath 是一个已经存在的目录- 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有写权限- 'fail the maximum size of the file storage limit is exceeded': 存储空间不足- 'fail sdcard not mounted': android sdcard 挂载失败

TruncateSyncOption

参数	类型	必填	说明
filePath	`string`	是	要截断的文件路径 (本地路径)
length	`number`	否	截断位置，默认0。如果 length 小于文件长度（字节），则只有前面 length 个字节会保留在文件中，其余内容会被删除；如果 length 大于文件长度，则会对其进行扩展，并且扩展部分将填充空字节（'\0'）

WriteOption

参数	类型	必填	说明
fd	`string`	是	文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得
data	string or ArrayBuffer	是	写入的内容，类型为 String 或 ArrayBuffer
offset	`number`	否	只在 data 类型是 ArrayBuffer 时有效，决定 arrayBuffe 中要被写入的部位，即 arrayBuffer 中的索引，默认0
length	`number`	否	只在 data 类型是 ArrayBuffer 时有效，指定要写入的字节数，默认为 arrayBuffer 从0开始偏移 offset 个字节后剩余的字节数
encoding	`keyof Encoding`	否	只在 data 类型是 String 时有效，指定写入文件的字符编码，默认为 utf8
position	`number`	否	指定文件开头的偏移量，即数据要被写入的位置。当 position 不传或者传入非 Number 类型的值时，数据会被写入当前指针所在位置。
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: WriteFailCallbackResult) => void`	否	接口调用失败的回调函数
success	`(res: WriteSuccessCallbackResult) => void`	否	接口调用成功的回调函数

WriteFailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：'bad file descriptor': 无效的文件描述符'fail permission denied': 指定的 fd 路径没有写权限'fail sdcard not mounted': android sdcard 挂载失败

WriteSuccessCallbackResult

参数	类型	说明
bytesWritten	`number`	实际被写入到文件中的字节数（注意，被写入的字节数不一定与被写入的字符串字符数相同）
errMsg	`string`	调用结果

WriteSyncOption

参数	类型	必填	说明
fd	`string`	是	文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得
data	string or ArrayBuffer	是	写入的内容，类型为 String 或 ArrayBuffer
offset	`number`	否	只在 data 类型是 ArrayBuffer 时有效，决定 arrayBuffe 中要被写入的部位，即 arrayBuffer 中的索引，默认0
length	`number`	否	只在 data 类型是 ArrayBuffer 时有效，指定要写入的字节数，默认为 arrayBuffer 从0开始偏移 offset 个字节后剩余的字节数
encoding	`keyof Encoding`	否	只在 data 类型是 String 时有效，指定写入文件的字符编码，默认为 utf8
position	`number`	否	指定文件开头的偏移量，即数据要被写入的位置。当 position 不传或者传入非 Number 类型的值时，数据会被写入当前指针所在位置。

API 支持度

API	微信小程序	百度小程序	支付宝小程序	抖音小程序	QQ 小程序	京东小程序	Harmony hybrid	ASCF元服务
FileSystemManager	✔️			✔️			✔️	✔️
FileSystemManager.access	✔️	✔️	✔️	✔️	✔️	✔️	✔️	✔️
FileSystemManager.accessSync	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.appendFile	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.appendFileSync	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.close	✔️							✔️
FileSystemManager.closeSync	✔️							✔️
FileSystemManager.copyFile	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.copyFileSync	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.fstat	✔️							✔️
FileSystemManager.fstatSync	✔️							✔️
FileSystemManager.ftruncate	✔️							✔️
FileSystemManager.ftruncateSync	✔️							✔️
FileSystemManager.getFileInfo	✔️	✔️	✔️	✔️	✔️	✔️	✔️	✔️
FileSystemManager.getSavedFileList	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.mkdir	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.mkdirSync	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.open	✔️							✔️
FileSystemManager.openSync	✔️							✔️
FileSystemManager.read	✔️							✔️
FileSystemManager.readCompressedFile	✔️
FileSystemManager.readCompressedFileSync	✔️
FileSystemManager.readdir	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.readdirSync	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.readFile	✔️	✔️	✔️	✔️	✔️	✔️	✔️	✔️
FileSystemManager.readFileSync	✔️	✔️	✔️	✔️	✔️	✔️	✔️	✔️
FileSystemManager.readSync	✔️							✔️
FileSystemManager.readZipEntry	✔️
FileSystemManager.removeSavedFile	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.rename	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.renameSync	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.rmdir	✔️			✔️				✔️
FileSystemManager.rmdirSync	✔️			✔️				✔️
FileSystemManager.saveFile	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.saveFileSync	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.stat	✔️	✔️	✔️		✔️	✔️		✔️
FileSystemManager.statSync	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.truncate	✔️			✔️				✔️
FileSystemManager.truncateSync	✔️			✔️				✔️
FileSystemManager.unlink	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.unlinkSync	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.unzip	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.write	✔️							✔️
FileSystemManager.writeFile	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.writeFileSync	✔️	✔️	✔️	✔️	✔️	✔️		✔️
FileSystemManager.writeSync	✔️							✔️

File: docs/apis/files/getFileInfo.md

获取该小程序下的本地临时文件或本地缓存文件信息

支持情况：

类型

tsx

(option: Option) => Promise<FailCallbackResult | SuccessCallbackResult>

参数

参数	类型
option	`Option`

Option

参数	类型	默认值	必填	说明
filePath	`string`		是	要读取的文件路径
apFilePath	`string`		否	本地文件路径API 支持度: alipay
digestAlgorithm	"md5" or "sha1"	`'md5'`	否	计算文件摘要的算法
complete	`(res: TaroGeneral.CallbackResult) => void`		否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(result: FailCallbackResult) => void`		否	接口调用失败的回调函数
success	`(result: SuccessCallbackResult) => void`		否	接口调用成功的回调函数

FailCallbackResult

参数	类型	说明
errMsg	`string`	错误信息可选值：- 'fail file not exist': 指定的 filePath 找不到文件;

SuccessCallbackResult

参数	类型	说明
size	`number`	文件大小，以字节为单位
digest	`string`	按照传入的 digestAlgorithm 计算得出的的文件摘要
errMsg	`string`	调用结果

示例代码

tsx

Taro.getFileInfo({
    success: function (res) {
        console.log(res.size)
        console.log(res.digest)
    }
})

File: docs/apis/files/getFileSystemManager.md

获取全局唯一的文件管理器

支持情况：

类型

tsx

() => FileSystemManager

File: docs/apis/files/getSavedFileInfo.md

获取本地文件的文件信息。此接口只能用于获取已保存到本地的文件，若需要获取临时文件信息，请使用 Taro.getFileInfo 接口。

支持情况：

类型

tsx

(option: Option) => Promise<SuccessCallbackResult>

参数

参数	类型
option	`Option`

Option

参数	类型	必填	说明
filePath	`string`	是	文件路径
apFilePath	`string`	否	文件路径API 支持度: alipay
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用失败的回调函数
success	`(result: SuccessCallbackResult) => void`	否	接口调用成功的回调函数

SuccessCallbackResult

参数	类型	说明
createTime	`number`	文件保存时的时间戳，从1970/01/01 08:00:00 到该时刻的秒数
size	`number`	文件大小，单位 B
errMsg	`string`	调用结果

示例代码

tsx

Taro.getSavedFileInfo({
  filePath: 'wxfile://somefile', //仅做示例用，非真正的文件路径
  success: function (res) {
    console.log(res.size)
    console.log(res.createTime)
  }
})

File: docs/apis/files/getSavedFileList.md

获取本地已保存的文件列表

支持情况：

类型

tsx

(option?: Option) => Promise<SuccessCallbackResult>

参数

参数	类型
option	`Option`

Option

参数	类型	必填	说明
complete	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用结束的回调函数（调用成功、失败都会执行）
fail	`(res: TaroGeneral.CallbackResult) => void`	否	接口调用失败的回调函数
success	`(result: SuccessCallbackResult) => void`	否	接口调用成功的回调函数

SuccessCallbackResult

参数	类型	说明
fileList	`FileItem[]`	文件数组
errMsg	`string`	调用结果

FileItem

文件数组

参数	类型	必填	说明
createTime	`number`	是	文件保存时的时间戳，从1970/01/01 08:00:00 到当前时间的秒数
filePath	`string`	是	本地路径
apFilePath	`string`	否	文件路径API 支持度: alipay
size	`number`	是	本地文件大小，以字节为单位

示例代码

tsx

Taro.getSavedFileList({
  success: function (res) {
    console.log(res.fileList)
  }
})

1. Project Overview & Quickstart (NervJS/taro) Copy Chapter

File: README.md Copy Chapter

目录 Copy Chapter

简介 Copy Chapter

版本迁移 Copy Section

学习资源 Copy Chapter

社区共享 Copy Chapter

UI 库 Copy Section

项目状态 Copy Chapter

使用案例 Copy Chapter

加入共建 Copy Chapter

加入 Taro 社区共建倡议

为 Taro 贡献代码

问题反馈与建议 Copy Chapter

特别鸣谢 Copy Chapter

贡献者们 Copy Chapter

开发计划 Copy Chapter

更新日志 Copy Chapter

开发交流 Copy Chapter

License Copy Chapter

File: docs/apis/framework/App.md Copy Chapter

title: App sidebar_label: App Copy Chapter

方法 Copy Chapter

File: docs/apis/framework/getApp.md Copy Chapter

title: Taro.getApp(opts) sidebar_label: getApp Copy Chapter

类型 Copy Chapter

参数 Copy Chapter

Option Copy Section

Instance Copy Section

API 支持度 Copy Chapter

File: docs/apis/framework/getCurrentPages.md Copy Chapter

title: Taro.getCurrentPages() sidebar_label: getCurrentPages Copy Chapter

类型 Copy Chapter

参数 Copy Chapter

示例代码 Copy Chapter

API 支持度 Copy Chapter

File: docs/apis/framework/Page.md Copy Chapter

title: Page sidebar_label: Page Copy Chapter

方法 Copy Chapter

File: docs/apis/files/FileSystemManager.md Copy Chapter

title: FileSystemManager sidebar_label: FileSystemManager Copy Chapter

方法 Copy Chapter

readdirSync Copy Section

API 支持度

access Copy Section

API 支持度

accessSync Copy Section

API 支持度

appendFile Copy Section

API 支持度

appendFileSync Copy Section

API 支持度

copyFile Copy Section

API 支持度

copyFileSync Copy Section

API 支持度

getFileInfo Copy Section

API 支持度

getSavedFileList Copy Section

API 支持度

mkdir Copy Section

API 支持度

mkdirSync Copy Section

API 支持度

readFile Copy Section

API 支持度

readdir Copy Section

API 支持度

removeSavedFile Copy Section

API 支持度

rename Copy Section

API 支持度

renameSync Copy Section

API 支持度

rmdir Copy Section

API 支持度

rmdirSync Copy Section

API 支持度

saveFile Copy Section

API 支持度

1. Project Overview & Quickstart (NervJS/taro)

File: README.md

目录

简介

版本迁移

学习资源

社区共享

UI 库

项目状态

使用案例

加入共建

问题反馈与建议

特别鸣谢

贡献者们

开发计划

更新日志

开发交流

License

File: docs/apis/framework/App.md

title: App sidebar_label: App

方法

File: docs/apis/framework/getApp.md

title: Taro.getApp(opts) sidebar_label: getApp

类型

参数

Option

Instance

API 支持度

File: docs/apis/framework/getCurrentPages.md

title: Taro.getCurrentPages() sidebar_label: getCurrentPages

类型

参数

示例代码

API 支持度

File: docs/apis/framework/Page.md

title: Page sidebar_label: Page

方法

File: docs/apis/files/FileSystemManager.md

title: FileSystemManager sidebar_label: FileSystemManager

方法

readdirSync

access

accessSync

appendFile

appendFileSync

copyFile

copyFileSync

getFileInfo

getSavedFileList

mkdir

mkdirSync

readFile

readdir

removeSavedFile

rename

renameSync

rmdir

rmdirSync

saveFile

stat

unlink

unlinkSync

unzip

writeFile

writeFileSync

statSync

saveFileSync

readFileSync

参数

encoding

AccessOption

AccessFailCallbackResult

AppendFileOption

AppendFileFailCallbackResult

CopyFileOption

CopyFileFailCallbackResult

getFileInfoOption

GetFileInfoFailCallbackResult

GetFileInfoSuccessCallbackResult

getSavedFileListOption