diff --git a/docs/apis/files/FileSystemManager.md b/docs/apis/files/FileSystemManager.md
index 2bc75a2431ce..d60317bbbde5 100644
--- a/docs/apis/files/FileSystemManager.md
+++ b/docs/apis/files/FileSystemManager.md
@@ -15,7 +15,7 @@ sidebar_label: FileSystemManager
判断文件/目录是否存在
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.access.html)
@@ -31,7 +31,7 @@ sidebar_label: FileSystemManager
[FileSystemManager.access](#access) 的同步版本
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.accessSync.html)
@@ -47,7 +47,7 @@ sidebar_label: FileSystemManager
在文件结尾追加内容
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.appendFile.html)
@@ -63,7 +63,7 @@ sidebar_label: FileSystemManager
[FileSystemManager.appendFile](#appendfile) 的同步版本
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.appendFileSync.html)
@@ -113,7 +113,7 @@ sidebar_label: FileSystemManager
复制文件
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.copyFile.html)
@@ -129,7 +129,7 @@ sidebar_label: FileSystemManager
[FileSystemManager.copyFile](#copyfile) 的同步版本
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.copyFileSync.html)
@@ -210,7 +210,7 @@ sidebar_label: FileSystemManager
获取该小程序下的 `本地临时文件` 或 `本地缓存文件` 信息
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.getFileInfo.html)
@@ -226,7 +226,7 @@ sidebar_label: FileSystemManager
获取该小程序下已保存的本地缓存文件列表
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.getSavedFileList.html)
@@ -242,7 +242,7 @@ sidebar_label: FileSystemManager
创建目录
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.mkdir.html)
@@ -258,7 +258,7 @@ sidebar_label: FileSystemManager
[FileSystemManager.mkdir](#mkdir) 的同步版本
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.mkdirSync.html)
@@ -355,7 +355,7 @@ sidebar_label: FileSystemManager
读取目录内文件列表
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.readdir.html)
@@ -371,7 +371,7 @@ sidebar_label: FileSystemManager
[FileSystemManager.readdir](#readdir) 的同步版本
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.readdirSync.html)
@@ -387,7 +387,7 @@ sidebar_label: FileSystemManager
读取本地文件内容
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.readFile.html)
@@ -403,7 +403,7 @@ sidebar_label: FileSystemManager
[FileSystemManager.readFile](#readfile) 的同步版本
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.readFileSync.html)
@@ -454,7 +454,7 @@ sidebar_label: FileSystemManager
删除该小程序下已保存的本地缓存文件
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.removeSavedFile.html)
@@ -470,7 +470,7 @@ sidebar_label: FileSystemManager
重命名文件。可以把文件从 oldPath 移动到 newPath
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.rename.html)
@@ -486,7 +486,7 @@ sidebar_label: FileSystemManager
[FileSystemManager.rename](#rename) 的同步版本
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.renameSync.html)
@@ -536,7 +536,7 @@ sidebar_label: FileSystemManager
保存临时文件到本地。此接口会移动临时文件,因此调用成功后,tempFilePath 将不可用。
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.saveFile.html)
@@ -552,7 +552,7 @@ sidebar_label: FileSystemManager
[FileSystemManager.saveFile](#savefile) 的同步版本
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.saveFileSync.html)
@@ -569,7 +569,7 @@ sidebar_label: FileSystemManager
获取文件 Stats 对象
-支持情况:
+支持情况:
```tsx
(option: StatOption) => void
@@ -583,7 +583,7 @@ sidebar_label: FileSystemManager
[FileSystemManager.stat](#stat) 的同步版本
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.statSync.html)
@@ -600,7 +600,7 @@ sidebar_label: FileSystemManager
对文件内容进行截断操作
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.truncate.html)
@@ -616,7 +616,7 @@ sidebar_label: FileSystemManager
对文件内容进行截断操作 ([truncate](#truncate) 的同步版本)
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.truncateSync.html)
@@ -632,7 +632,7 @@ sidebar_label: FileSystemManager
删除文件
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.unlink.html)
@@ -648,7 +648,7 @@ sidebar_label: FileSystemManager
[FileSystemManager.unlink](#unlink) 的同步版本
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.unlinkSync.html)
@@ -664,7 +664,7 @@ sidebar_label: FileSystemManager
解压文件
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.unzip.html)
@@ -696,7 +696,7 @@ sidebar_label: FileSystemManager
写文件
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.writeFile.html)
@@ -712,7 +712,7 @@ sidebar_label: FileSystemManager
[FileSystemManager.writeFile](#writefile) 的同步版本
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.writeFileSync.html)
@@ -787,8 +787,8 @@ sidebar_label: FileSystemManager
| --- | --- | :---: | --- |
| data | string or ArrayBuffer | 是 | 要追加的文本或二进制数据 |
| filePath | `string` | 是 | 要追加内容的文件路径 |
-| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
| encoding | `keyof Encoding` | 否 | 指定写入文件的字符编码 |
+| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
| fail | `(result: AppendFileFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 |
| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 |
@@ -816,12 +816,13 @@ sidebar_label: FileSystemManager
### getFileInfoOption
-| 参数 | 类型 | 必填 | 说明 |
-| --- | --- | :---: | --- |
-| filePath | `string` | 是 | 要读取的文件路径 |
-| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
-| fail | `(result: GetFileInfoFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 |
-| success | `(result: GetFileInfoSuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 |
+| 参数 | 类型 | 默认值 | 必填 | 说明 |
+| --- | --- | :---: | :---: | --- |
+| filePath | `string` | | 是 | 要读取的文件路径 |
+| digestAlgorithm | "md5" or "sha1" | `"md5"` | 否 | 计算文件摘要的算法 |
+| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
+| fail | `(result: GetFileInfoFailCallbackResult) => void` | | 否 | 接口调用失败的回调函数 |
+| success | `(result: GetFileInfoSuccessCallbackResult) => void` | | 否 | 接口调用成功的回调函数 |
### GetFileInfoFailCallbackResult
@@ -831,10 +832,11 @@ sidebar_label: FileSystemManager
### GetFileInfoSuccessCallbackResult
-| 参数 | 类型 | 说明 |
-| --- | --- | --- |
-| size | `number` | 文件大小,以字节为单位 |
-| errMsg | `string` | 调用结果 |
+| 参数 | 类型 | 必填 | 说明 |
+| --- | --- | :---: | --- |
+| size | `number` | 是 | 文件大小,以字节为单位 |
+| digest | `string` | 否 | 按照传入的 digestAlgorithm 计算得出的的文件摘要 |
+| errMsg | `string` | 是 | 调用结果 |
### getSavedFileListOption
@@ -863,13 +865,13 @@ sidebar_label: FileSystemManager
### MkdirOption
-| 参数 | 类型 | 必填 | 说明 |
-| --- | --- | :---: | --- |
-| dirPath | `string` | 是 | 创建的目录路径 |
-| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
-| fail | `(result: MkdirFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 |
-| recursive | `boolean` | 否 | 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在,则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true,将创建 a 目录,再在 a 目录下创建 b 目录,以此类推直至创建 a/b/c 目录下的 d 目录。 |
-| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 |
+| 参数 | 类型 | 默认值 | 必填 | 说明 |
+| --- | --- | :---: | :---: | --- |
+| 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
@@ -994,6 +996,7 @@ FailCallbackResult | SuccessCallbackResult
| 参数 | 类型 | 必填 | 说明 |
| --- | --- | :---: | --- |
| filePath | `string` | 是 | 需要删除的文件路径 |
+| apFilePath | `string` | 是 | 本地缓存文件路径
API 支持度: alipay |
| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
| fail | `(result: RemoveSavedFileFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 |
| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 |
@@ -1387,51 +1390,51 @@ FailCallbackResult | SuccessCallbackResult
## API 支持度
-| API | 微信小程序 | 抖音小程序 | H5 | React Native | Harmony |
-| :---: | :---: | :---: | :---: | :---: | :---: |
-| 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 | ✔️ | | | | |
+| API | 微信小程序 | 百度小程序 | 支付宝小程序 | 抖音小程序 | QQ 小程序 | 京东小程序 | H5 | React Native | Harmony |
+| :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
+| 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 | ✔️ | | | | | | | | |
diff --git a/docs/apis/files/Stats.md b/docs/apis/files/Stats.md
index af6d7b816853..e8f95ea64ba5 100644
--- a/docs/apis/files/Stats.md
+++ b/docs/apis/files/Stats.md
@@ -22,7 +22,7 @@ sidebar_label: Stats
判断当前文件是否一个目录
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/Stats.isDirectory.html)
@@ -34,7 +34,7 @@ sidebar_label: Stats
判断当前文件是否一个普通文件
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/Stats.isFile.html)
@@ -44,8 +44,8 @@ sidebar_label: Stats
## API 支持度
-| API | 微信小程序 | H5 | React Native | Harmony |
-| :---: | :---: | :---: | :---: | :---: |
-| Stats | ✔️ | | | |
-| Stats.isDirectory | ✔️ | | | |
-| Stats.isFile | ✔️ | | | |
+| API | 微信小程序 | 支付宝小程序 | 抖音小程序 | QQ 小程序 | 京东小程序 | H5 | React Native | Harmony |
+| :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
+| Stats | ✔️ | | | | | | | |
+| Stats.isDirectory | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | |
+| Stats.isFile | ✔️ | | ✔️ | ✔️ | ✔️ | | | |
diff --git a/docs/apis/files/getFileInfo.md b/docs/apis/files/getFileInfo.md
index ad210a09fb15..fbe2db3a5bfa 100644
--- a/docs/apis/files/getFileInfo.md
+++ b/docs/apis/files/getFileInfo.md
@@ -5,7 +5,7 @@ sidebar_label: getFileInfo
获取该小程序下的 本地临时文件 或 本地缓存文件 信息
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.getFileInfo.html)
@@ -26,7 +26,8 @@ sidebar_label: getFileInfo
| 参数 | 类型 | 默认值 | 必填 | 说明 |
| --- | --- | :---: | :---: | --- |
| filePath | `string` | | 是 | 要读取的文件路径 |
-| digestAlgorithm | "md5" or "sha1" | `'md5'` | 否 | 计算文件摘要的算法 |
+| apFilePath | `string` | | 是 | 本地文件路径
API 支持度: alipay |
+| digestAlgorithm | "md5" or "sha1" | `"md5"` | 否 | 计算文件摘要的算法 |
| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
| fail | `(result: FailCallbackResult) => void` | | 否 | 接口调用失败的回调函数 |
| success | `(result: SuccessCallbackResult) => void` | | 否 | 接口调用成功的回调函数 |
diff --git a/docs/apis/files/getFileSystemManager.md b/docs/apis/files/getFileSystemManager.md
index a8f02b24285f..08172540cfc4 100644
--- a/docs/apis/files/getFileSystemManager.md
+++ b/docs/apis/files/getFileSystemManager.md
@@ -5,7 +5,7 @@ sidebar_label: getFileSystemManager
获取全局唯一的文件管理器
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.getFileSystemManager.html)
diff --git a/docs/apis/files/getSavedFileInfo.md b/docs/apis/files/getSavedFileInfo.md
index c7690bff124e..9d3497396401 100644
--- a/docs/apis/files/getSavedFileInfo.md
+++ b/docs/apis/files/getSavedFileInfo.md
@@ -5,7 +5,7 @@ sidebar_label: getSavedFileInfo
获取本地文件的文件信息。此接口只能用于获取已保存到本地的文件,若需要获取临时文件信息,请使用 [Taro.getFileInfo](/docs/apis/files/getFileInfo) 接口。
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.getSavedFileInfo.html)
@@ -26,6 +26,7 @@ sidebar_label: getSavedFileInfo
| 参数 | 类型 | 必填 | 说明 |
| --- | --- | :---: | --- |
| filePath | `string` | 是 | 文件路径 |
+| apFilePath | `string` | 是 | 文件路径
API 支持度: alipay |
| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 |
| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 |
diff --git a/docs/apis/files/getSavedFileList.md b/docs/apis/files/getSavedFileList.md
index e3a41960cd88..41bb3678865b 100644
--- a/docs/apis/files/getSavedFileList.md
+++ b/docs/apis/files/getSavedFileList.md
@@ -5,7 +5,7 @@ sidebar_label: getSavedFileList
获取本地已保存的文件列表
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.getSavedFileList.html)
@@ -44,6 +44,7 @@ sidebar_label: getSavedFileList
| --- | --- | --- |
| createTime | `number` | 文件保存时的时间戳,从1970/01/01 08:00:00 到当前时间的秒数 |
| filePath | `string` | 本地路径 |
+| apFilePath | `string` | 文件路径
API 支持度: alipay |
| size | `number` | 本地文件大小,以字节为单位 |
## 示例代码
diff --git a/docs/apis/files/openDocument.md b/docs/apis/files/openDocument.md
index 6b9212ce6af7..6a7775821e30 100644
--- a/docs/apis/files/openDocument.md
+++ b/docs/apis/files/openDocument.md
@@ -5,7 +5,7 @@ sidebar_label: openDocument
新开页面打开文档,支持格式
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.openDocument.html)
diff --git a/docs/apis/files/saveFile.md b/docs/apis/files/saveFile.md
index aa4be33331dc..bf569f6674be 100644
--- a/docs/apis/files/saveFile.md
+++ b/docs/apis/files/saveFile.md
@@ -5,7 +5,7 @@ sidebar_label: saveFile
保存文件到本地。**注意:saveFile 会把临时文件移动,因此调用成功后传入的 tempFilePath 将不可用**
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.saveFile.html)
@@ -29,6 +29,7 @@ sidebar_label: saveFile
| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
| fail | `(result: FailCallbackResult) => void` | 否 | 接口调用失败的回调函数 |
| filePath | `string` | 否 | 要存储的文件路径 |
+| apFilePath | `string` | 是 | 要保存的本地临时文件路径
API 支持度: alipay |
| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 |
### FailCallbackResult
diff --git a/docs/apis/files/saveFileToDisk.md b/docs/apis/files/saveFileToDisk.md
index b73eb1ac74c0..9cf2359cb2e5 100644
--- a/docs/apis/files/saveFileToDisk.md
+++ b/docs/apis/files/saveFileToDisk.md
@@ -5,7 +5,7 @@ sidebar_label: saveFileToDisk
保存文件系统的文件到用户磁盘,仅在 PC 端支持
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.saveFileToDisk.html)
diff --git a/docs/apis/location/chooseLocation.md b/docs/apis/location/chooseLocation.md
index 2033c7b6f906..9d2eb3e00e3b 100644
--- a/docs/apis/location/chooseLocation.md
+++ b/docs/apis/location/chooseLocation.md
@@ -7,7 +7,7 @@ sidebar_label: chooseLocation
`chooseLocation` api功能是依赖于腾讯位置服务,所以需要使用 api 密钥。如果您没有,可以前往腾讯位置服务[开发者控制台](https://lbs.qq.com/console/mykey.html?console=mykey)进行申请。
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.chooseLocation.html)
@@ -30,19 +30,26 @@ sidebar_label: chooseLocation
| latitude | `number` | 否 | 目标地纬度 |
| longitude | `number` | 否 | 目标地经度 |
| mapOpts | `Record` | 否 | 地图选点组件参数
API 支持度: h5
h5: 仅支持 H5 使用
[参考地址](https://lbs.qq.com/webApi/component/componentGuide/componentPicker) |
+| title | `string` | 否 | 页面显示标题
API 支持度: alipay
alipay: 安卓默认值为 位置,iOS、IDE 默认值为 你在哪里?
[参考地址](https://opendocs.alipay.com/mini/api/location?pathHash=951b46a1) |
| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 |
| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 |
| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
### SuccessCallbackResult
-| 参数 | 类型 | 说明 |
-| --- | --- | --- |
-| address | `string` | 详细地址 |
-| latitude | `number` | 纬度,浮点数,范围为-90~90,负数表示南纬。使用 gcj02 国测局坐标系 |
-| longitude | `number` | 经度,浮点数,范围为-180~180,负数表示西经。使用 gcj02 国测局坐标系 |
-| name | `string` | 位置名称 |
-| errMsg | `string` | 调用结果 |
+| 参数 | 类型 | 必填 | 说明 |
+| --- | --- | :---: | --- |
+| address | `string` | 是 | 详细地址 |
+| latitude | `number` | 是 | 纬度,浮点数,范围为-90~90,负数表示南纬。使用 gcj02 国测局坐标系 |
+| longitude | `number` | 是 | 经度,浮点数,范围为-180~180,负数表示西经。使用 gcj02 国测局坐标系 |
+| name | `string` | 是 | 位置名称 |
+| adCode | `number` | 否 | 区县代码
API 支持度: alipay |
+| adName | `string` | 否 | 区县名称
API 支持度: alipay |
+| cityCode | `string` | 否 | 城市代码
API 支持度: alipay |
+| cityName | `string` | 否 | 城市名称
API 支持度: alipay |
+| provinceCode | `number` | 否 | 省份代码
API 支持度: alipay |
+| provinceName | `string` | 否 | 省份名称
API 支持度: alipay |
+| errMsg | `string` | 是 | 调用结果 |
## 示例代码
diff --git a/docs/apis/location/getFuzzyLocation.md b/docs/apis/location/getFuzzyLocation.md
index 052f8d94c45b..62ae6433586c 100644
--- a/docs/apis/location/getFuzzyLocation.md
+++ b/docs/apis/location/getFuzzyLocation.md
@@ -25,11 +25,18 @@ sidebar_label: getFuzzyLocation
| 参数 | 类型 | 必填 | 说明 |
| --- | --- | :---: | --- |
-| type | "wgs84" or "gcj02" | 否 | wgs84 返回 gps 坐标,gcj02 返回可用于 Taro.openLocation 的坐标 |
+| type | `keyof Type` | 否 | wgs84 返回 gps 坐标,gcj02 返回可用于 Taro.openLocation 的坐标 |
| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 |
| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 |
+### Type
+
+| 参数 | 说明 |
+| --- | --- |
+| wgs84 | 返回 gps 坐标 |
+| gcj02 | 返回 gcj02 坐标 |
+
### SuccessCallbackResult
| 参数 | 类型 | 说明 |
diff --git a/docs/apis/location/getLocation.md b/docs/apis/location/getLocation.md
index 4e9f28a1ee5b..8a42c7980414 100644
--- a/docs/apis/location/getLocation.md
+++ b/docs/apis/location/getLocation.md
@@ -9,7 +9,7 @@ sidebar_label: getLocation
- 工具中定位模拟使用IP定位,可能会有一定误差。且工具目前仅支持 gcj02 坐标。
- 使用第三方服务进行逆地址解析时,请确认第三方服务默认的坐标系,正确进行坐标转换。
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.getLocation.html)
@@ -27,28 +27,38 @@ sidebar_label: getLocation
### Option
-| 参数 | 类型 | 必填 | 说明 |
-| --- | --- | :---: | --- |
-| altitude | `string` | 否 | 传入 true 会返回高度信息,由于获取高度需要较高精确度,会减慢接口返回速度 |
-| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
-| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 |
-| highAccuracyExpireTime | `number` | 否 | 高精度定位超时时间(ms),指定时间内返回最高精度,该值3000ms以上高精度定位才有效果 |
-| isHighAccuracy | `boolean` | 否 | 开启高精度定位 |
-| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 |
-| type | `string` | 否 | wgs84 返回 gps 坐标,gcj02 返回可用于 Taro.openLocation 的坐标 |
+| 参数 | 类型 | 默认值 | 必填 | 说明 |
+| --- | --- | :---: | :---: | --- |
+| altitude | `boolean` | `false` | 否 | 传入 true 会返回高度信息,由于获取高度需要较高精确度,会减慢接口返回速度 |
+| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
+| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 |
+| highAccuracyExpireTime | `number` | | 否 | 高精度定位超时时间(ms),指定时间内返回最高精度,该值3000ms以上高精度定位才有效果 |
+| isHighAccuracy | `boolean` | `false` | 否 | 开启高精度定位 |
+| success | `(result: SuccessCallbackResult) => void` | | 否 | 接口调用成功的回调函数 |
+| type | `string` | `"wgs84"` | 否 | wgs84 返回 gps 坐标,gcj02 返回可用于 Taro.openLocation 的坐标 |
+| needFullAccuracy | `boolean` | `false` | 否 | 针对 iOS14/Android12 及以上的新特性,其他情况本参数忽略。默认情况宿主是精确定位就返回精确定位信息。
传入 true 会强制使用精确定位信息,iOS14/Android12 及以上如果没有精确定位权限,会弹出精确定位授权弹框
API 支持度: swan |
### SuccessCallbackResult
-| 参数 | 类型 | 说明 |
-| --- | --- | --- |
-| accuracy | `number` | 位置的精确度 |
-| altitude | `number` | 高度,单位 m |
-| horizontalAccuracy | `number` | 水平精度,单位 m |
-| latitude | `number` | 纬度,范围为 -90~90,负数表示南纬 |
-| longitude | `number` | 经度,范围为 -180~180,负数表示西经 |
-| speed | `number` | 速度,单位 m/s |
-| verticalAccuracy | `number` | 垂直精度,单位 m(Android 无法获取,返回 0) |
-| errMsg | `string` | 调用结果 |
+| 参数 | 类型 | 必填 | 说明 |
+| --- | --- | :---: | --- |
+| accuracy | `number` | 是 | 位置的精确度 |
+| altitude | `number` | 是 | 高度,单位 m |
+| horizontalAccuracy | `number` | 是 | 水平精度,单位 m |
+| latitude | `number` | 是 | 纬度,范围为 -90~90,负数表示南纬 |
+| longitude | `number` | 是 | 经度,范围为 -180~180,负数表示西经 |
+| speed | `number` | 是 | 速度,单位 m/s |
+| verticalAccuracy | `number` | 是 | 垂直精度,单位 m(Android 无法获取,返回 0) |
+| street | `string` | 否 | 城市名称
API 支持度: swan |
+| cityCode | `string` | 否 | 国家代码
API 支持度: swan |
+| city | `string` | 否 | 城市名称
API 支持度: swan, tt |
+| country | `string` | 否 | 国家
API 支持度: swan |
+| countryCode | `string` | 否 | 国家代码
API 支持度: swan |
+| province | `string` | 否 | 省份
API 支持度: swan |
+| streetNumber | `string` | 否 | 街道号码
API 支持度: swan |
+| district | `string` | 否 | 区
API 支持度: swan |
+| isFullAccuracy | `boolean` | 否 | 是不是精确定位信息
API 支持度: swan |
+| errMsg | `string` | 是 | 调用结果 |
## 示例代码
diff --git a/docs/apis/location/offLocationChange.md b/docs/apis/location/offLocationChange.md
index d6a7b01489d5..2346bf155d14 100644
--- a/docs/apis/location/offLocationChange.md
+++ b/docs/apis/location/offLocationChange.md
@@ -5,18 +5,18 @@ sidebar_label: offLocationChange
取消监听实时地理位置变化事件
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.offLocationChange.html)
## 类型
```tsx
-(callback: (res: TaroGeneral.CallbackResult) => void) => void
+(callback?: Callback) => void
```
## 参数
| 参数 | 类型 | 说明 |
| --- | --- | --- |
-| callback | `(res: TaroGeneral.CallbackResult) => void` | 实时地理位置变化事件的回调函数 |
+| callback | `Callback` | 实时地理位置变化事件的回调函数 |
diff --git a/docs/apis/location/offLocationChangeError.md b/docs/apis/location/offLocationChangeError.md
index cfb7314565a9..c0cacc35fbff 100644
--- a/docs/apis/location/offLocationChangeError.md
+++ b/docs/apis/location/offLocationChangeError.md
@@ -12,7 +12,7 @@ sidebar_label: offLocationChangeError
## 类型
```tsx
-(callback: Callback) => void
+(callback?: Callback) => void
```
## 参数
diff --git a/docs/apis/location/onLocationChange.md b/docs/apis/location/onLocationChange.md
index 3b4b600f9e47..e409fa055f20 100644
--- a/docs/apis/location/onLocationChange.md
+++ b/docs/apis/location/onLocationChange.md
@@ -5,7 +5,7 @@ sidebar_label: onLocationChange
监听实时地理位置变化事件,需结合 Taro.startLocationUpdateBackground、Taro.startLocationUpdate 使用。
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.onLocationChange.html)
@@ -35,15 +35,24 @@ sidebar_label: onLocationChange
### CallbackResult
-| 参数 | 类型 | 说明 |
-| --- | --- | --- |
-| accuracy | `number` | 位置的精确度 |
-| altitude | `number` | 高度,单位 m |
-| horizontalAccuracy | `number` | 水平精度,单位 m |
-| latitude | `number` | 纬度,范围为 -90~90,负数表示南纬 |
-| longitude | `number` | 经度,范围为 -180~180,负数表示西经 |
-| speed | `number` | 速度,单位 m/s |
-| verticalAccuracy | `number` | 垂直精度,单位 m(Android 无法获取,返回 0) |
+| 参数 | 类型 | 必填 | 说明 |
+| --- | --- | :---: | --- |
+| accuracy | `number` | 是 | 位置的精确度 |
+| altitude | `number` | 是 | 高度,单位 m |
+| horizontalAccuracy | `number` | 是 | 水平精度,单位 m |
+| latitude | `number` | 是 | 纬度,范围为 -90~90,负数表示南纬 |
+| longitude | `number` | 是 | 经度,范围为 -180~180,负数表示西经 |
+| speed | `number` | 是 | 速度,单位 m/s |
+| verticalAccuracy | `number` | 是 | 垂直精度,单位 m(Android 无法获取,返回 0) |
+| street | `string` | 否 | 街道名称
API 支持度: swan |
+| cityCode | `string` | 否 | 城市编码
API 支持度: swan |
+| city | `string` | 否 | 城市名称
API 支持度: swan, tt
tt: iOS 不支持 |
+| country | `string` | 否 | 国家
API 支持度: swan |
+| countryCode | `string` | 否 | 国家代码
API 支持度: swan |
+| province | `string` | 否 | 省份
API 支持度: swan |
+| streetNumber | `string` | 否 | 街道号码
API 支持度: swan |
+| district | `string` | 否 | 区
API 支持度: swan |
+| isFullAccuracy | `boolean` | 否 | 是不是精确定位信息
API 支持度: swan |
## 示例代码
diff --git a/docs/apis/location/onLocationChangeError.md b/docs/apis/location/onLocationChangeError.md
index 2459b4de6d7f..ceea7f0ef57a 100644
--- a/docs/apis/location/onLocationChangeError.md
+++ b/docs/apis/location/onLocationChangeError.md
@@ -35,6 +35,7 @@ sidebar_label: onLocationChangeError
### CallbackResult
-| 参数 | 类型 | 说明 |
-| --- | --- | --- |
-| errCode | `number` | 错误码 |
+| 参数 | 类型 | 必填 | 说明 |
+| --- | --- | :---: | --- |
+| errCode | `number` | 是 | 错误码 |
+| errMsg | `string` | 否 | 错误信息
API 支持度: tt
tt: 最低支持版本 2.48.0 |
diff --git a/docs/apis/location/openLocation.md b/docs/apis/location/openLocation.md
index c2a8be458c2d..8a3c69ecb3ce 100644
--- a/docs/apis/location/openLocation.md
+++ b/docs/apis/location/openLocation.md
@@ -5,7 +5,7 @@ sidebar_label: openLocation
使用微信内置地图查看位置
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.openLocation.html)
@@ -27,11 +27,12 @@ sidebar_label: openLocation
| --- | --- | :---: | --- |
| latitude | `number` | 是 | 纬度,范围为-90~90,负数表示南纬。使用 gcj02 国测局坐标系 |
| longitude | `number` | 是 | 经度,范围为-180~180,负数表示西经。使用 gcj02 国测局坐标系 |
+| scale | `number` | 否 | 缩放比例
weapp: 范围 5~18,默认值18
alipay: 范围 3~19,默认值15 |
+| name | `string` | 否 | 位置名 |
| address | `string` | 否 | 地址的详细说明 |
+| ignoredApps | `any[]` | 否 | 定义在拉起的地图 App 面板中需要被屏蔽的地图类 App
API 支持度: swan |
| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 |
-| name | `string` | 否 | 位置名 |
-| scale | `number` | 否 | 缩放比例,范围5~18 |
| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 |
## 示例代码
diff --git a/docs/apis/location/startLocationUpdate.md b/docs/apis/location/startLocationUpdate.md
index ed56304b4018..eacbbf7ee09c 100644
--- a/docs/apis/location/startLocationUpdate.md
+++ b/docs/apis/location/startLocationUpdate.md
@@ -8,7 +8,7 @@ sidebar_label: startLocationUpdate
**注意**
- 获取位置信息需配置[地理位置用途说明](https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#permission)。
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.startLocationUpdate.html)
@@ -26,8 +26,10 @@ sidebar_label: startLocationUpdate
### Option
-| 参数 | 类型 | 必填 | 说明 |
-| --- | --- | :---: | --- |
-| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
-| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 |
-| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 |
+| 参数 | 类型 | 默认值 | 必填 | 说明 |
+| --- | --- | :---: | :---: | --- |
+| type | `string` | `"gcj02"` | 否 | wgs84 返回 gps 坐标,gcj02 返回可用于 wx.openLocation 的坐标 |
+| needFullAccuracy | `boolean` | `false` | 否 | 针对 iOS14/Android12 及以上的新特性,其他情况本参数忽略。默认情况宿主是精确定位就返回精确定位信息。
传入 true 会强制使用精确定位信息,iOS14/Android12 及以上如果没有精确定位权限,会弹出精确定位授权弹框
API 支持度: swan |
+| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
+| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 |
+| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 |
diff --git a/docs/apis/location/startLocationUpdateBackground.md b/docs/apis/location/startLocationUpdateBackground.md
index a467de721265..cb94cf604d9e 100644
--- a/docs/apis/location/startLocationUpdateBackground.md
+++ b/docs/apis/location/startLocationUpdateBackground.md
@@ -28,8 +28,9 @@ sidebar_label: startLocationUpdateBackground
### Option
-| 参数 | 类型 | 必填 | 说明 |
-| --- | --- | :---: | --- |
-| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
-| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 |
-| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 |
+| 参数 | 类型 | 默认值 | 必填 | 说明 |
+| --- | --- | :---: | :---: | --- |
+| type | `string` | `"gcj02"` | 否 | wgs84 返回 gps 坐标,gcj02 返回可用于 wx.openLocation 的坐标 |
+| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
+| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 |
+| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 |
diff --git a/docs/apis/location/stopLocationUpdate.md b/docs/apis/location/stopLocationUpdate.md
index 139f0de6a335..47b9f49c965b 100644
--- a/docs/apis/location/stopLocationUpdate.md
+++ b/docs/apis/location/stopLocationUpdate.md
@@ -5,7 +5,7 @@ sidebar_label: stopLocationUpdate
关闭监听实时位置变化,前后台都停止消息接收
-支持情况:
+支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.stopLocationUpdate.html)
diff --git a/docs/components/forms/form.md b/docs/components/forms/form.md
index 4da26219ea6b..fa39b05d9950 100755
--- a/docs/components/forms/form.md
+++ b/docs/components/forms/form.md
@@ -92,7 +92,7 @@ export default {
| --- | --- | :---: | :---: | --- |
| reportSubmit | `boolean` | `false` | 否 | 是否返回 `formId` 用于发送模板消息。 |
| reportSubmitTimeout | `number` | `0` | 否 | 等待一段时间(毫秒数)以确认 `formId` 是否生效。
如果未指定这个参数,`formId` 有很小的概率是无效的(如遇到网络失败的情况)。
指定这个参数将可以检测 `formId` 是否有效,
以这个参数的时间作为这项检测的超时时间。
如果失败,将返回 `requestFormId:fail` 开头的 `formId`。 |
-| reportType | `string` | `'default'` | 否 | 模板消息的类型,report-submit 为 true 时填写有效
取值:default / subscribe |
+| reportType | `string` | `"default"` | 否 | 模板消息的类型,report-submit 为 true 时填写有效
取值:default / subscribe |
| templateId | string or string[] | | 否 | 发送订阅类模板消息所用的模板库标题 ID ,可通过 getTemplateLibraryList 获取
当参数类型为 Array 时,可传递 1~3 个模板库标题 ID (注:此处填写模板库id。示例:BD0001) |
| subscribeId | `string` | | 否 | 发送订阅类模板消息时所使用的唯一标识符,内容由开发者自定义,用来标识订阅场景
注意:同一用户在同一 subscribe-id 下的多次授权不累积下发权限,只能下发一条。若要订阅多条,需要不同 subscribe-id |
| conversionTarget | `number` | `0` | 否 | 用于分发目的。取值:0 或 1,其中 0 表示默认,1 表示留资目标,需要和留资分发配置一起使用,详情见留资分发配置 |
diff --git a/docs/components/media/video.md b/docs/components/media/video.md
index d52b65f7fe49..c32c79fc0124 100755
--- a/docs/components/media/video.md
+++ b/docs/components/media/video.md
@@ -95,7 +95,7 @@ export default class PageView extends Component {
| poster | `string` | | 否 | 视频封面的图片网络资源地址,如果 controls 属性值为 false 则设置 poster 无效 |
| showMuteBtn | `boolean` | `false` | 否 | 是否显示静音按钮 |
| title | `string` | | 否 | 视频的标题,全屏时在顶部展示 |
-| playBtnPosition | `keyof PlayBtnPosition` | `'bottom'` | 否 | 播放按钮的位置
- `bottom`: controls bar 上
- `center`: 视频中间 |
+| playBtnPosition | `keyof PlayBtnPosition` | `"bottom"` | 否 | 播放按钮的位置
- `bottom`: controls bar 上
- `center`: 视频中间 |
| enablePlayGesture | `boolean` | `false` | 否 | 是否开启播放手势,即双击切换播放/暂停 |
| autoPauseIfNavigate | `boolean` | `true` | 否 | 当跳转到其它小程序页面时,是否自动暂停本页面的视频 |
| autoPauseIfOpenNative | `boolean` | `true` | 否 | 当跳转到其它微信原生页面时,是否自动暂停本页面的视频 |
diff --git a/docs/components/navig/navigation-bar.md b/docs/components/navig/navigation-bar.md
index fe36d5b60746..2f4dd6a82810 100644
--- a/docs/components/navig/navigation-bar.md
+++ b/docs/components/navig/navigation-bar.md
@@ -6,6 +6,11 @@ sidebar_label: NavigationBar
页面导航条配置节点,用于指定导航栏的一些属性。只能是 PageMeta 组件内的第一个节点,需要配合它一同使用。
通过这个节点可以获得类似于调用 Taro.setNavigationBarTitle Taro.setNavigationBarColor 等接口调用的效果。
+:::info
+Taro v3.6.19 开始支持
+需要配合 PageMeta 组件使用
+:::
+
支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/component/navigation-bar.html)
diff --git a/docs/components/page-meta.md b/docs/components/page-meta.md
index fbc135211963..0f7b066182d2 100644
--- a/docs/components/page-meta.md
+++ b/docs/components/page-meta.md
@@ -6,6 +6,11 @@ sidebar_label: PageMeta
页面属性配置节点,用于指定页面的一些属性、监听页面事件。只能是页面内的第一个节点。可以配合 navigation-bar 组件一同使用。
通过这个节点可以获得类似于调用 Taro.setBackgroundTextStyle Taro.setBackgroundColor 等接口调用的效果。
+:::info
+Taro v3.6.19 开始支持
+开发者需要在页面配置里添加:`enablePageMeta: true`
+:::
+
支持情况:
> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/component/page-meta.html)
@@ -16,6 +21,49 @@ sidebar_label: PageMeta
ComponentType
```
+## 示例代码
+
+import { ReactIcon, VueIcon } from '@site/static/icons'
+import Tabs from '@theme/Tabs'
+import TabItem from '@theme/TabItem'
+
+, value: "React" }, { label: , value: "Vue" }]}>
+
+
+```tsx
+// page.config.ts
+export default definePageConfig({ enablePageMeta: true, ... })
+
+// page.tsx
+function Index () {
+ return (
+
+
+
+
+
+ )
+}
+```
+
+
+
+```html
+
+
+
+
+
+
+
+
## PageMetaProps
| 参数 | 类型 | 默认值 | 必填 | 说明 |
diff --git a/docs/components/viewContainer/scroll-view.md b/docs/components/viewContainer/scroll-view.md
index ada3f0c12340..32d2f4f49498 100755
--- a/docs/components/viewContainer/scroll-view.md
+++ b/docs/components/viewContainer/scroll-view.md
@@ -193,8 +193,8 @@ typeof ScrollViewProps
| scrollAnchoring | `boolean` | `false` | 否 | 开启 scroll anchoring 特性,即控制滚动位置不随内容变化而抖动,仅在 iOS 下生效,安卓下可参考 CSS `overflow-anchor` 属性。 |
| refresherEnabled | `boolean` | `false` | 否 | 开启自定义下拉刷新 |
| refresherThreshold | `number` | `45` | 否 | 设置自定义下拉刷新阈值 |
-| refresherDefaultStyle | `string` | `'black'` | 否 | 设置自定义下拉刷新默认样式,支持设置 `black or white or none`, none 表示不使用默认样式 |
-| refresherBackground | `string` | `'#FFF'` | 否 | 设置自定义下拉刷新区域背景颜色 |
+| refresherDefaultStyle | `string` | `"black"` | 否 | 设置自定义下拉刷新默认样式,支持设置 `black or white or none`, none 表示不使用默认样式 |
+| refresherBackground | `string` | `"#FFF"` | 否 | 设置自定义下拉刷新区域背景颜色 |
| refresherTriggered | `boolean` | `false` | 否 | 设置当前下拉刷新状态,true 表示下拉刷新已经被触发,false 表示下拉刷新未被触发 |
| enhanced | `boolean` | `false` | 否 | 启用 scroll-view 增强特性 |
| bounces | `boolean` | `true` | 否 | iOS 下 scroll-view 边界弹性控制 (同时开启 enhanced 属性后生效) |
@@ -207,14 +207,14 @@ typeof ScrollViewProps
| disableUpperScroll | `string` | | 否 | 发生滚动前,对滚动方向进行判断,当方向是底部/右边时,如果值为 always 将始终禁止滚动,如果值为 out-of-bounds 且当前已经滚动到底部/右边,禁止滚动。 |
| ariaLabel | `string` | | 否 | 无障碍访问,(属性)元素的额外描述 |
| enablePassive | `boolean` | `false` | 否 | 开启 passive 特性,能优化一定的滚动性能 |
-| type | "list" or "custom" | `'list'` | 否 | 渲染模式
list - 列表模式。只会渲染在屏节点,会根据直接子节点是否在屏来按需渲染,若只有一个直接子节点则性能会退化
custom - 自定义模式。只会渲染在屏节点,子节点可以是 sticky-section list-view grid-view 等组件 |
+| type | "list" or "custom" | `"list"` | 否 | 渲染模式
list - 列表模式。只会渲染在屏节点,会根据直接子节点是否在屏来按需渲染,若只有一个直接子节点则性能会退化
custom - 自定义模式。只会渲染在屏节点,子节点可以是 sticky-section list-view grid-view 等组件 |
| reverse | `boolean` | `false` | 否 | 是否反向滚动。一般初始滚动位置是在顶部,反向滚动则是在底部。 |
| clip | `boolean` | `true` | 否 | 是否对溢出进行裁剪,默认开启 |
| cacheExtent | `number` | | 否 | 指定视口外渲染区域的距离,默认情况下视口外节点不渲染。指定 cache-extent 可优化滚动体验和加载速度,但会提高内存占用且影响首屏速度,可按需启用。 |
| minDragDistance | `number` | `18` | 否 | 指定 scroll-view 触发滚动的最小拖动距离。仅在 scroll-view 和其他组件存在手势冲突时使用,可通过调整该属性使得滚动更加灵敏。 |
| padding | `[number, number, number, number]` | `[0,0,0,0]` | 否 | 长度为 4 的数组,按 top、right、bottom、left 顺序指定内边距 |
| scrollIntoViewWithinExtent | `boolean` | `false` | 否 | 只 scroll-into-view 到 cacheExtent 以内的目标节点,性能更佳 |
-| scrollIntoViewAlignment | "start" or "center" or "end" or "nearest" | `'start'` | 否 | 指定 scroll-into-view 目标节点在视口内的位置。
start - 目标节点显示在视口开始处
center - 目标节点显示在视口中间
end - 目标节点显示在视口结束处
nearest - 目标节点在就近的视口边缘显示,若节点已在视口内则不触发滚动 |
+| scrollIntoViewAlignment | "start" or "center" or "end" or "nearest" | `"start"` | 否 | 指定 scroll-into-view 目标节点在视口内的位置。
start - 目标节点显示在视口开始处
center - 目标节点显示在视口中间
end - 目标节点显示在视口结束处
nearest - 目标节点在就近的视口边缘显示,若节点已在视口内则不触发滚动 |
| refresherTwoLevelEnabled | `boolean` | `false` | 否 | 开启下拉二级能力 |
| refresherTwoLevelTriggered | `boolean` | `false` | 否 | 设置打开/关闭二级 |
| refresherTwoLevelThreshold | `number` | `150` | 否 | 下拉二级阈值 |
diff --git a/packages/taro-components/types/Form.d.ts b/packages/taro-components/types/Form.d.ts
index 65ba1e5bd8b9..fe7bbe76e149 100644
--- a/packages/taro-components/types/Form.d.ts
+++ b/packages/taro-components/types/Form.d.ts
@@ -17,7 +17,7 @@ interface FormProps extends StandardProps {
reportSubmitTimeout?: number
/** 模板消息的类型,report-submit 为 true 时填写有效
* 取值:default / subscribe
- * @default 'default'
+ * @default "default"
* @supported swan
*/
reportType?: string
diff --git a/packages/taro-components/types/LivePlayer.d.ts b/packages/taro-components/types/LivePlayer.d.ts
index cd15d3bd20e7..70ae0b345bc3 100644
--- a/packages/taro-components/types/LivePlayer.d.ts
+++ b/packages/taro-components/types/LivePlayer.d.ts
@@ -127,11 +127,16 @@ interface LivePlayerProps extends StandardProps {
/** 用户选择投屏设备时触发 detail = { state: "success"/"fail" }
* @supported weapp
*/
- onCastingUserSelect?: CommonEventFunction<{ state: 'success' | 'fail' }>
+ onCastingUserSelect?: CommonEventFunction<{
+ state: 'success' | 'fail'
+ }>
/** 投屏成功/失败时触发 detail = { type, state: "success"/"fail" }
* @supported weapp
*/
- onCastingStateChange?: CommonEventFunction<{ type: any, state: 'success' | 'fail' }>
+ onCastingStateChange?: CommonEventFunction<{
+ type: any
+ state: 'success' | 'fail'
+ }>
/** 投屏被中断时触发
* @supported weapp
*/
diff --git a/packages/taro-components/types/NavigationBar.d.ts b/packages/taro-components/types/NavigationBar.d.ts
index bbf090a6a762..a2a1c575a9b8 100644
--- a/packages/taro-components/types/NavigationBar.d.ts
+++ b/packages/taro-components/types/NavigationBar.d.ts
@@ -30,6 +30,12 @@ interface NavigationBarProps extends StandardProps {
}
/** 页面导航条配置节点,用于指定导航栏的一些属性。只能是 PageMeta 组件内的第一个节点,需要配合它一同使用。
* 通过这个节点可以获得类似于调用 Taro.setNavigationBarTitle Taro.setNavigationBarColor 等接口调用的效果。
+ *
+ * :::info
+ * Taro v3.6.19 开始支持
+ * 需要配合 PageMeta 组件使用
+ * :::
+ *
* @classification navig
* @supported weapp, harmony
* @see https://developers.weixin.qq.com/miniprogram/dev/component/navigation-bar.html
diff --git a/packages/taro-components/types/PageMeta.d.ts b/packages/taro-components/types/PageMeta.d.ts
index 53bfe00208ac..7f5fda6cb086 100644
--- a/packages/taro-components/types/PageMeta.d.ts
+++ b/packages/taro-components/types/PageMeta.d.ts
@@ -80,7 +80,47 @@ declare namespace PageMetaProps {
}
/** 页面属性配置节点,用于指定页面的一些属性、监听页面事件。只能是页面内的第一个节点。可以配合 navigation-bar 组件一同使用。
* 通过这个节点可以获得类似于调用 Taro.setBackgroundTextStyle Taro.setBackgroundColor 等接口调用的效果。
+ *
+ * :::info
+ * Taro v3.6.19 开始支持
+ * 开发者需要在页面配置里添加:`enablePageMeta: true`
+ * :::
+ *
* @supported weapp, alipay
+ * @example_react
+ * ```tsx
+ * // page.config.ts
+ * export default definePageConfig({ enablePageMeta: true, ... })
+ *
+ * // page.tsx
+ * function Index () {
+ * return (
+ *
+ *
+ *
+ *
+ *
+ * )
+ * }
+ * ```
+ * @example_vue
+ * ```html
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * ```
* @see https://developers.weixin.qq.com/miniprogram/dev/component/page-meta.html
*/
declare const PageMeta: ComponentType
diff --git a/packages/taro-components/types/ScrollView.d.ts b/packages/taro-components/types/ScrollView.d.ts
index 504753612e16..90077ae84fa1 100644
--- a/packages/taro-components/types/ScrollView.d.ts
+++ b/packages/taro-components/types/ScrollView.d.ts
@@ -67,12 +67,12 @@ interface ScrollViewProps extends StandardProps {
refresherThreshold?: number
/** 设置自定义下拉刷新默认样式,支持设置 `black | white | none`, none 表示不使用默认样式
* @supported weapp
- * @default 'black'
+ * @default "black"
*/
refresherDefaultStyle?: string
/** 设置自定义下拉刷新区域背景颜色
* @supported weapp
- * @default '#FFF'
+ * @default "#FFF"
*/
refresherBackground?: string
/** 设置当前下拉刷新状态,true 表示下拉刷新已经被触发,false 表示下拉刷新未被触发
@@ -135,7 +135,7 @@ interface ScrollViewProps extends StandardProps {
* list - 列表模式。只会渲染在屏节点,会根据直接子节点是否在屏来按需渲染,若只有一个直接子节点则性能会退化
* custom - 自定义模式。只会渲染在屏节点,子节点可以是 sticky-section list-view grid-view 等组件
* @supported weapp
- * @default 'list'
+ * @default "list"
*/
type?: 'list' | 'custom'
/** 是否反向滚动。一般初始滚动位置是在顶部,反向滚动则是在底部。
@@ -173,7 +173,7 @@ interface ScrollViewProps extends StandardProps {
* end - 目标节点显示在视口结束处
* nearest - 目标节点在就近的视口边缘显示,若节点已在视口内则不触发滚动
* @supported weapp, h5
- * @default 'start'
+ * @default "start"
*/
scrollIntoViewAlignment?: 'start' | 'center' | 'end' | 'nearest'
/** 开启下拉二级能力
diff --git a/packages/taro-components/types/Video.d.ts b/packages/taro-components/types/Video.d.ts
index 9a7ae133e410..380977e83574 100644
--- a/packages/taro-components/types/Video.d.ts
+++ b/packages/taro-components/types/Video.d.ts
@@ -103,7 +103,7 @@ interface VideoProps extends StandardProps {
* - `bottom`: controls bar 上
* - `center`: 视频中间
*
- * @default 'bottom'
+ * @default "bottom"
* @supported weapp, tt, qq
*/
playBtnPosition?: keyof VideoProps.PlayBtnPosition
diff --git a/packages/taro/types/api/files/index.d.ts b/packages/taro/types/api/files/index.d.ts
index 494f82114980..4673d393cb33 100644
--- a/packages/taro/types/api/files/index.d.ts
+++ b/packages/taro/types/api/files/index.d.ts
@@ -24,6 +24,10 @@ declare module '../../index' {
fail?: (result: FailCallbackResult) => void
/** 要存储的文件路径 */
filePath?: string
+ /** 要保存的本地临时文件路径
+ * @supported alipay
+ */
+ apFilePath: string
/** 接口调用成功的回调函数 */
success?: (result: SuccessCallbackResult) => void
}
@@ -120,6 +124,10 @@ declare module '../../index' {
createTime: number
/** 本地路径 */
filePath: string
+ /** 文件路径
+ * @supported alipay
+ */
+ apFilePath: string
/** 本地文件大小,以字节为单位 */
size: number
}
@@ -129,6 +137,10 @@ declare module '../../index' {
interface Option {
/** 文件路径 */
filePath: string
+ /** 文件路径
+ * @supported alipay
+ */
+ apFilePath: string
/** 接口调用结束的回调函数(调用成功、失败都会执行) */
complete?: (res: TaroGeneral.CallbackResult) => void
/** 接口调用失败的回调函数 */
@@ -150,9 +162,13 @@ declare module '../../index' {
interface Option {
/** 要读取的文件路径 */
filePath: string
+ /** 本地文件路径
+ * @supported alipay
+ */
+ apFilePath: string
/**
* 计算文件摘要的算法
- * @default 'md5'
+ * @default "md5"
*/
digestAlgorithm?: 'md5' | 'sha1'
/** 接口调用结束的回调函数(调用成功、失败都会执行) */
@@ -185,12 +201,12 @@ declare module '../../index' {
*/
interface FileSystemManager {
/** 判断文件/目录是否存在
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.access.html
*/
access(option: FileSystemManager.AccessOption): void
/** [FileSystemManager.access](#access) 的同步版本
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.accessSync.html
*/
accessSync(
@@ -198,12 +214,12 @@ declare module '../../index' {
path: string,
): void
/** 在文件结尾追加内容
- * @supported weapp
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.appendFile.html
*/
appendFile(option: FileSystemManager.AppendFileOption): void
/** [FileSystemManager.appendFile](#appendfile) 的同步版本
- * @supported weapp
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.appendFileSync.html
*/
appendFileSync(
@@ -225,12 +241,12 @@ declare module '../../index' {
*/
closeSync(option: FileSystemManager.CloseSyncOption): void
/** 复制文件
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.copyFile.html
*/
copyFile(option: FileSystemManager.CopyFileOption): void
/** [FileSystemManager.copyFile](#copyfile) 的同步版本
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.copyFileSync.html
*/
copyFileSync(
@@ -260,22 +276,22 @@ declare module '../../index' {
*/
ftruncateSync(option: FileSystemManager.FtruncateSyncOption): void
/** 获取该小程序下的 `本地临时文件` 或 `本地缓存文件` 信息
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.getFileInfo.html
*/
getFileInfo(option: FileSystemManager.getFileInfoOption): void
/** 获取该小程序下已保存的本地缓存文件列表
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.getSavedFileList.html
*/
getSavedFileList(option?: FileSystemManager.getSavedFileListOption): void
/** 创建目录
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.mkdir.html
*/
mkdir(option: FileSystemManager.MkdirOption): void
/** [FileSystemManager.mkdir](#mkdir) 的同步版本
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.mkdirSync.html
*/
mkdirSync(
@@ -310,12 +326,12 @@ declare module '../../index' {
*/
readCompressedFileSync(option: FileSystemManager.readCompressedFileSync.Option): ArrayBuffer /** 文件读取结果 */
/** 读取目录内文件列表
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.readdir.html
*/
readdir(option: FileSystemManager.ReaddirOption): void
/** [FileSystemManager.readdir](#readdir) 的同步版本
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.readdirSync.html
*/
readdirSync(
@@ -323,12 +339,12 @@ declare module '../../index' {
dirPath: string,
): string[]
/** 读取本地文件内容
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.readFile.html
*/
readFile(option: FileSystemManager.ReadFileOption): void
/** [FileSystemManager.readFile](#readfile) 的同步版本
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.readFileSync.html
*/
readFileSync(
@@ -359,17 +375,17 @@ declare module '../../index' {
*/
readZipEntry(option: FileSystemManager.readZipEntry.Option): Promise
/** 删除该小程序下已保存的本地缓存文件
- * @supported weapp
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.removeSavedFile.html
*/
removeSavedFile(option: FileSystemManager.RemoveSavedFileOption): void
/** 重命名文件。可以把文件从 oldPath 移动到 newPath
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.rename.html
*/
rename(option: FileSystemManager.RenameOption): void
/** [FileSystemManager.rename](#rename) 的同步版本
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.renameSync.html
*/
renameSync(
@@ -394,12 +410,12 @@ declare module '../../index' {
recursive?: boolean,
): void
/** 保存临时文件到本地。此接口会移动临时文件,因此调用成功后,tempFilePath 将不可用。
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.saveFile.html
*/
saveFile(option: FileSystemManager.SaveFileOption): void
/** [FileSystemManager.saveFile](#savefile) 的同步版本
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.saveFileSync.html
*/
saveFileSync(
@@ -409,12 +425,12 @@ declare module '../../index' {
filePath?: string,
): string
/** 获取文件 Stats 对象
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.stat.html
*/
stat(option: FileSystemManager.StatOption): void
/** [FileSystemManager.stat](#stat) 的同步版本
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.statSync.html
*/
statSync(
@@ -424,22 +440,22 @@ declare module '../../index' {
recursive?: boolean,
): Stats | TaroGeneral.IAnyObject
/** 对文件内容进行截断操作
- * @supported weapp
+ * @supported weapp, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.truncate.html
*/
truncate(option: FileSystemManager.TruncateOption): void
/** 对文件内容进行截断操作 ([truncate](#truncate) 的同步版本)
- * @supported weapp
+ * @supported weapp, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.truncateSync.html
*/
truncateSync(option: FileSystemManager.TruncateSyncOption): void
/** 删除文件
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.unlink.html
*/
unlink(option: FileSystemManager.UnlinkOption): void
/** [FileSystemManager.unlink](#unlink) 的同步版本
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.unlinkSync.html
*/
unlinkSync(
@@ -447,7 +463,7 @@ declare module '../../index' {
filePath: string,
): void
/** 解压文件
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.unzip.html
*/
unzip(option: FileSystemManager.UnzipOption): void
@@ -457,12 +473,12 @@ declare module '../../index' {
*/
write(option: FileSystemManager.WriteOption): void
/** 写文件
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.writeFile.html
*/
writeFile(option: FileSystemManager.WriteFileOption): void
/** [FileSystemManager.writeFile](#writefile) 的同步版本
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.writeFileSync.html
*/
writeFileSync(
@@ -543,10 +559,10 @@ declare module '../../index' {
data: string | ArrayBuffer
/** 要追加内容的文件路径 */
filePath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: (res: TaroGeneral.CallbackResult) => void
/** 指定写入文件的字符编码 */
encoding?: keyof FileSystemManager.Encoding
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
+ complete?: (res: TaroGeneral.CallbackResult) => void
/** 接口调用失败的回调函数 */
fail?: (result: AppendFileFailCallbackResult) => void
/** 接口调用成功的回调函数 */
@@ -590,6 +606,11 @@ declare module '../../index' {
interface getFileInfoOption {
/** 要读取的文件路径 */
filePath: string
+ /**
+ * 计算文件摘要的算法
+ * @default "md5"
+ */
+ digestAlgorithm?: 'md5' | 'sha1'
/** 接口调用结束的回调函数(调用成功、失败都会执行) */
complete?: (res: TaroGeneral.CallbackResult) => void
/** 接口调用失败的回调函数 */
@@ -608,6 +629,8 @@ declare module '../../index' {
interface GetFileInfoSuccessCallbackResult extends TaroGeneral.CallbackResult {
/** 文件大小,以字节为单位 */
size: number
+ /** 按照传入的 digestAlgorithm 计算得出的的文件摘要 */
+ digest?: string
/** 调用结果 */
errMsg: string
}
@@ -640,12 +663,15 @@ declare module '../../index' {
interface MkdirOption {
/** 创建的目录路径 */
dirPath: string
+ /** 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在,则不创建该上级目录。
+ * 如 dirPath 为 a/b/c/d 且 recursive 为 true,将创建 a 目录,再在 a 目录下创建 b 目录,以此类推直至创建 a/b/c 目录下的 d 目录。
+ * @default false
+ */
+ recursive?: boolean
/** 接口调用结束的回调函数(调用成功、失败都会执行) */
complete?: (res: TaroGeneral.CallbackResult) => void
/** 接口调用失败的回调函数 */
fail?: (result: MkdirFailCallbackResult) => void
- /** 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在,则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true,将创建 a 目录,再在 a 目录下创建 b 目录,以此类推直至创建 a/b/c 目录下的 d 目录。 */
- recursive?: boolean
/** 接口调用成功的回调函数 */
success?: (res: TaroGeneral.CallbackResult) => void
}
@@ -789,6 +815,10 @@ declare module '../../index' {
interface RemoveSavedFileOption {
/** 需要删除的文件路径 */
filePath: string
+ /** 本地缓存文件路径
+ * @supported alipay
+ */
+ apFilePath: string
/** 接口调用结束的回调函数(调用成功、失败都会执行) */
complete?: (res: TaroGeneral.CallbackResult) => void
/** 接口调用失败的回调函数 */
@@ -1286,12 +1316,12 @@ declare module '../../index' {
/** 文件最后一次被修改的时间,UNIX 时间戳,对应 POSIX stat.st_mtime */
lastModifiedTime: number
/** 判断当前文件是否一个目录
- * @supported weapp
+ * @supported weapp, alipay, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/Stats.isDirectory.html
*/
isDirectory(): boolean
/** 判断当前文件是否一个普通文件
- * @supported weapp
+ * @supported weapp, aliapy, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/Stats.isFile.html
*/
isFile(): boolean
@@ -1308,7 +1338,7 @@ declare module '../../index' {
interface TaroStatic {
/** 保存文件系统的文件到用户磁盘,仅在 PC 端支持
- * @supported weapp
+ * @supported weapp, alipay
* @example
* ```tsx
* Taro.saveFileToDisk({
@@ -1326,7 +1356,7 @@ declare module '../../index' {
saveFileToDisk(option: saveFileToDisk.Option): Promise
/** 保存文件到本地。**注意:saveFile 会把临时文件移动,因此调用成功后传入的 tempFilePath 将不可用**
- * @supported weapp, rn, tt
+ * @supported weapp, alipay, swan, jd, qq, tt, rn
* @example
* ```tsx
* Taro.chooseImage({
@@ -1367,7 +1397,7 @@ declare module '../../index' {
removeSavedFile(option: removeSavedFile.Option): Promise
/** 新开页面打开文档,支持格式
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @example
```tsx
* Taro.downloadFile({
@@ -1388,7 +1418,7 @@ declare module '../../index' {
openDocument(option: openDocument.Option): Promise
/** 获取本地已保存的文件列表
- * @supported weapp, rn, tt
+ * @supported weapp, alipay, swan, jd, qq, tt, rn
* @example
* ```tsx
* Taro.getSavedFileList({
@@ -1402,7 +1432,7 @@ declare module '../../index' {
getSavedFileList(option?: getSavedFileList.Option): Promise
/** 获取本地文件的文件信息。此接口只能用于获取已保存到本地的文件,若需要获取临时文件信息,请使用 [Taro.getFileInfo](/docs/apis/files/getFileInfo) 接口。
- * @supported weapp, rn
+ * @supported weapp, alipay, swan, jd, qq, rn
* @example
* ```tsx
* Taro.getSavedFileInfo({
@@ -1419,7 +1449,7 @@ declare module '../../index' {
/**
* 获取该小程序下的 本地临时文件 或 本地缓存文件 信息
- * @supported weapp, rn, tt
+ * @supported weapp, alipay, swan, jd, qq, tt, rn
* @example
* ```tsx
* Taro.getFileInfo({
@@ -1434,7 +1464,7 @@ declare module '../../index' {
getFileInfo(option: getFileInfo.Option): Promise
/** 获取全局唯一的文件管理器
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, jd, qq, tt
* @see https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.getFileSystemManager.html
*/
getFileSystemManager(): FileSystemManager
diff --git a/packages/taro/types/api/location/index.d.ts b/packages/taro/types/api/location/index.d.ts
index 82816c3f807c..baa3f96bdd39 100644
--- a/packages/taro/types/api/location/index.d.ts
+++ b/packages/taro/types/api/location/index.d.ts
@@ -7,16 +7,23 @@ declare module '../../index' {
latitude: number
/** 经度,范围为-180~180,负数表示西经。使用 gcj02 国测局坐标系 */
longitude: number
+ /** 缩放比例
+ * @weapp 范围 5~18,默认值18
+ * @alipay 范围 3~19,默认值15
+ */
+ scale?: number
+ /** 位置名 */
+ name?: string
/** 地址的详细说明 */
address?: string
+ /** 定义在拉起的地图 App 面板中需要被屏蔽的地图类 App
+ * @supported swan
+ */
+ ignoredApps?: Array
/** 接口调用结束的回调函数(调用成功、失败都会执行) */
complete?: (res: TaroGeneral.CallbackResult) => void
/** 接口调用失败的回调函数 */
fail?: (res: TaroGeneral.CallbackResult) => void
- /** 位置名 */
- name?: string
- /** 缩放比例,范围5~18 */
- scale?: number
/** 接口调用成功的回调函数 */
success?: (res: TaroGeneral.CallbackResult) => void
}
@@ -24,20 +31,32 @@ declare module '../../index' {
namespace getLocation {
interface Option {
- /** 传入 true 会返回高度信息,由于获取高度需要较高精确度,会减慢接口返回速度 */
- altitude?: string
+ /** 传入 true 会返回高度信息,由于获取高度需要较高精确度,会减慢接口返回速度
+ * @default false
+ */
+ altitude?: boolean
/** 接口调用结束的回调函数(调用成功、失败都会执行) */
complete?: (res: TaroGeneral.CallbackResult) => void
/** 接口调用失败的回调函数 */
fail?: (res: TaroGeneral.CallbackResult) => void
/** 高精度定位超时时间(ms),指定时间内返回最高精度,该值3000ms以上高精度定位才有效果 */
highAccuracyExpireTime?: number
- /** 开启高精度定位 */
+ /** 开启高精度定位
+ * @default false
+ */
isHighAccuracy?: boolean
/** 接口调用成功的回调函数 */
success?: (result: SuccessCallbackResult) => void
- /** wgs84 返回 gps 坐标,gcj02 返回可用于 Taro.openLocation 的坐标 */
+ /** wgs84 返回 gps 坐标,gcj02 返回可用于 Taro.openLocation 的坐标
+ * @default "wgs84"
+ */
type?: string
+ /** 针对 iOS14/Android12 及以上的新特性,其他情况本参数忽略。默认情况宿主是精确定位就返回精确定位信息。
+ * 传入 true 会强制使用精确定位信息,iOS14/Android12 及以上如果没有精确定位权限,会弹出精确定位授权弹框
+ * @supported swan
+ * @default false
+ */
+ needFullAccuracy?: boolean
}
interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
/** 位置的精确度 */
@@ -54,6 +73,42 @@ declare module '../../index' {
speed: number
/** 垂直精度,单位 m(Android 无法获取,返回 0) */
verticalAccuracy: number
+ /** 城市名称
+ * @supported swan
+ */
+ street?: string
+ /** 国家代码
+ * @supported swan
+ */
+ cityCode?: string
+ /** 城市名称
+ * @supported swan, tt
+ */
+ city?: string
+ /** 国家
+ * @supported swan
+ */
+ country?: string
+ /** 国家代码
+ * @supported swan
+ */
+ countryCode?: string
+ /** 省份
+ * @supported swan
+ */
+ province?: string
+ /** 街道号码
+ * @supported swan
+ */
+ streetNumber?: string
+ /** 区
+ * @supported swan
+ */
+ district?: string
+ /** 是不是精确定位信息
+ * @supported swan
+ */
+ isFullAccuracy?: boolean
/** 调用结果 */
errMsg: string
}
@@ -97,6 +152,12 @@ declare module '../../index' {
* @see https://lbs.qq.com/webApi/component/componentGuide/componentPicker
*/
mapOpts?: Record
+ /** 页面显示标题
+ * @supported alipay
+ * @alipay 安卓默认值为 位置,iOS、IDE 默认值为 你在哪里?
+ * @see https://opendocs.alipay.com/mini/api/location?pathHash=951b46a1
+ */
+ title?: string
/** 接口调用成功的回调函数 */
success?: (result: SuccessCallbackResult) => void
/** 接口调用失败的回调函数 */
@@ -114,6 +175,30 @@ declare module '../../index' {
longitude: number
/** 位置名称 */
name: string
+ /** 区县代码
+ * @supported alipay
+ */
+ adCode?: number
+ /** 区县名称
+ * @supported alipay
+ */
+ adName?: string
+ /** 城市代码
+ * @supported alipay
+ */
+ cityCode?: string
+ /** 城市名称
+ * @supported alipay
+ */
+ cityName?: string
+ /** 省份代码
+ * @supported alipay
+ */
+ provinceCode?: number
+ /** 省份名称
+ * @supported alipay
+ */
+ provinceName?: string
/** 调用结果 */
errMsg: string
}
@@ -132,6 +217,10 @@ declare module '../../index' {
namespace startLocationUpdateBackground {
interface Option {
+ /** wgs84 返回 gps 坐标,gcj02 返回可用于 wx.openLocation 的坐标
+ * @default "gcj02"
+ */
+ type?: string
/** 接口调用结束的回调函数(调用成功、失败都会执行) */
complete?: (res: TaroGeneral.CallbackResult) => void
/** 接口调用失败的回调函数 */
@@ -143,6 +232,16 @@ declare module '../../index' {
namespace startLocationUpdate {
interface Option {
+ /** wgs84 返回 gps 坐标,gcj02 返回可用于 wx.openLocation 的坐标
+ * @default "gcj02"
+ */
+ type?: string
+ /** 针对 iOS14/Android12 及以上的新特性,其他情况本参数忽略。默认情况宿主是精确定位就返回精确定位信息。
+ * 传入 true 会强制使用精确定位信息,iOS14/Android12 及以上如果没有精确定位权限,会弹出精确定位授权弹框
+ * @supported swan
+ * @default false
+ */
+ needFullAccuracy?: boolean
/** 接口调用结束的回调函数(调用成功、失败都会执行) */
complete?: (res: TaroGeneral.CallbackResult) => void
/** 接口调用失败的回调函数 */
@@ -161,6 +260,11 @@ declare module '../../index' {
interface CallbackResult {
/** 错误码 */
errCode: number
+ /** 错误信息
+ * @supported tt
+ * @tt 最低支持版本 2.48.0
+ */
+ errMsg?: string
}
}
@@ -185,13 +289,50 @@ declare module '../../index' {
speed: number
/** 垂直精度,单位 m(Android 无法获取,返回 0) */
verticalAccuracy: number
+ /** 街道名称
+ * @supported swan
+ */
+ street?: string
+ /** 城市编码
+ * @supported swan
+ */
+ cityCode?: string
+ /** 城市名称
+ * @supported swan, tt
+ * @tt iOS 不支持
+ */
+ city?: string
+ /** 国家
+ * @supported swan
+ */
+ country?: string
+ /** 国家代码
+ * @supported swan
+ */
+ countryCode?: string
+ /** 省份
+ * @supported swan
+ */
+ province?: string
+ /** 街道号码
+ * @supported swan
+ */
+ streetNumber?: string
+ /** 区
+ * @supported swan
+ */
+ district?: string
+ /** 是不是精确定位信息
+ * @supported swan
+ */
+ isFullAccuracy?: boolean
}
}
namespace getFuzzyLocation {
interface Option {
/** wgs84 返回 gps 坐标,gcj02 返回可用于 Taro.openLocation 的坐标 */
- type?: 'wgs84' | 'gcj02'
+ type?: keyof Type
/** 接口调用结束的回调函数(调用成功、失败都会执行) */
complete?: (res: TaroGeneral.CallbackResult) => void
/** 接口调用失败的回调函数 */
@@ -200,6 +341,13 @@ declare module '../../index' {
success?: (result: SuccessCallbackResult) => void
}
+ interface Type {
+ /** 返回 gps 坐标 */
+ wgs84
+ /** 返回 gcj02 坐标*/
+ gcj02
+ }
+
interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
/** 纬度,范围为 -90~90,负数表示南纬 */
latitude: number
@@ -210,7 +358,7 @@ declare module '../../index' {
interface TaroStatic {
/** 关闭监听实时位置变化,前后台都停止消息接收
- * @supported weapp, rn, tt
+ * @supported weapp, swan, tt, rn
* @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.stopLocationUpdate.html
*/
stopLocationUpdate(option?: stopLocationUpdate.Option): void
@@ -232,13 +380,13 @@ declare module '../../index' {
*
* **注意**
* - 获取位置信息需配置[地理位置用途说明](https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#permission)。
- * @supported weapp, rn, tt
+ * @supported weapp, swan, tt, rn
* @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.startLocationUpdate.html
*/
startLocationUpdate(option?: startLocationUpdate.Option): void
/** 使用微信内置地图查看位置
- * @supported weapp, h5, tt
+ * @supported weapp, alipay, swan, jd, tt, h5
* @example
* ```tsx
* Taro.getLocation({
@@ -268,7 +416,7 @@ declare module '../../index' {
): void
/** 监听实时地理位置变化事件,需结合 Taro.startLocationUpdateBackground、Taro.startLocationUpdate 使用。
- * @supported weapp, rn, tt
+ * @supported weapp, swan, tt, rn
* @example
* ```tsx
* const _locationChangeFn = function (res) {
@@ -290,16 +438,16 @@ declare module '../../index' {
*/
offLocationChangeError(
/** 监听持续定位接口返回失败时触发的回调函数 */
- callback: onLocationChangeError.Callback,
+ callback?: onLocationChangeError.Callback,
): void
/** 取消监听实时地理位置变化事件
- * @supported weapp, rn, tt
+ * @supported weapp, swan, tt, rn
* @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.offLocationChange.html
*/
offLocationChange(
/** 实时地理位置变化事件的回调函数 */
- callback: (res: TaroGeneral.CallbackResult) => void,
+ callback?: onLocationChange.Callback,
): void
/** 获取当前的地理位置、速度。当用户离开小程序后,此接口无法调用。开启高精度定位,接口耗时会增加,可指定 highAccuracyExpireTime 作为超时时间。
@@ -307,7 +455,7 @@ declare module '../../index' {
* **注意**
* - 工具中定位模拟使用IP定位,可能会有一定误差。且工具目前仅支持 gcj02 坐标。
* - 使用第三方服务进行逆地址解析时,请确认第三方服务默认的坐标系,正确进行坐标转换。
- * @supported weapp, rn, tt
+ * @supported weapp, swan, jd, qq, tt, rn
* @example
* ```tsx
* Taro.getLocation({
@@ -333,7 +481,7 @@ declare module '../../index' {
/** 打开地图选择位置。
*
* `chooseLocation` api功能是依赖于腾讯位置服务,所以需要使用 api 密钥。如果您没有,可以前往腾讯位置服务[开发者控制台](https://lbs.qq.com/console/mykey.html?console=mykey)进行申请。
- * @supported weapp, h5, tt
+ * @supported weapp, alipay, swan, jd, tt, h5
* @example
* ```tsx
* // config/index.js
diff --git a/packages/taro/types/compile/config/mini.d.ts b/packages/taro/types/compile/config/mini.d.ts
index c3ba5d0c73b2..3d21873000b4 100644
--- a/packages/taro/types/compile/config/mini.d.ts
+++ b/packages/taro/types/compile/config/mini.d.ts
@@ -3,13 +3,13 @@ import type Chain from 'webpack-chain'
import type { IOption, IPostcssOption } from './util'
interface Runtime {
- enableInnerHTML: boolean
- enableSizeAPIs: boolean
- enableAdjacentHTML: boolean
- enableTemplateContent: boolean
- enableCloneNode: boolean
- enableContains: boolean
- enableMutationObserver: boolean
+ enableInnerHTML?: boolean
+ enableSizeAPIs?: boolean
+ enableAdjacentHTML?: boolean
+ enableTemplateContent?: boolean
+ enableCloneNode?: boolean
+ enableContains?: boolean
+ enableMutationObserver?: boolean
}
export interface IMiniAppConfig {
@@ -45,7 +45,7 @@ export interface IMiniAppConfig {
/**
* 编译前清空输出目录
* @since Taro v3.6.9
- * @description
+ * @description
* - 默认清空输出目录,可设置 clean: false 不清空
* - 可设置 clean: { keep: ['project.config.json'] } 保留指定文件
* - 注意 clean.keep 不支持函数
diff --git a/packages/taro/types/taro.config.d.ts b/packages/taro/types/taro.config.d.ts
index b99e974127fb..fd40e8c336fe 100644
--- a/packages/taro/types/taro.config.d.ts
+++ b/packages/taro/types/taro.config.d.ts
@@ -175,6 +175,12 @@ declare module './index' {
* @default false
*/
enableShareTimeline?: boolean
+ /**
+ * 页面是否需要使用 \ 和 \ 组件
+ * @default false
+ * @support weapp, alipay
+ */
+ enablePageMeta?: boolean
/** 页面自定义组件配置
* @see https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/
*/