tmui-cli 2.0.3 → 2.0.4

package/data/uniappx/api/download-file.md

@@ -0,0 +1,226 @@
+::: sourceCode
+## uni.downloadFile(options) @downloadfile
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-network
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-network
+
+下载文件资源到本地，客户端直接发起一个 HTTP GET 请求，返回文件的本地临时路径。
+
+### downloadFile 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 3.91 | 4.11 | 4.61 |
+
+下载文件常见场景是apk的下载更新，[app升级中心](https://doc.dcloud.net.cn/uniCloud/upgrade-center.html)是一个现成的开源项目，实现下载进度在通知栏显示等复杂交互，可直接使用。
+
+### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| options | **DownloadFileOptions** | 是 |
+| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
+| :- | :- | :- | :- |  :-: | :- |
+| url | string | 是 |  | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 下载资源的 url |
+| header | UTSJSONObject | 否 | null | 微信小程序 4.41 / Android 3.91 / iOS 4.11（部分支持，见上） | HTTP 请求 Header，header 中不能设置 Referer |
+| filePath | string | 否 | null | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 指定文件下载路径<br/>支持相对路径与绝对路径，例：<br/>`/imgs/pic.png`、`/storage/emulated/0/Android/data/io.dcloud.HBuilder/apps/HBuilder/temp/imgs/pic.png`<br/>并且支持指定下载目录，例：<br/>`/imgs/`<br/>支持uni.env的平台兼容性：Android自3.9开始支持uni.env，iOS自4.13开始支持uni.env |
+| timeout | number | 否 | 120000 | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 超时时间，单位 ms |
+| success | (result: [DownloadFileSuccess](#downloadfilesuccess-values)) => void | 否 | null | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 下载成功后以 tempFilePath 的形式传给页面，res = {tempFilePath: '文件的临时路径'} |
+| fail | (result: [DownloadFileFail](#downloadfilefail-values)) => void | 否 | null | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 失败的回调函数 |
+| complete | (result: any) => void | 否 | null | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 结束的回调函数（调用成功、失败都会执行） |
+| enableHttp2 | boolean | 否 |  | 微信小程序 4.41（部分支持，见上） | 需要基础库： `2.10.4`<br/><br/>是否开启 http2<br/> |
+| enableProfile | boolean | 否 |  | 微信小程序 4.41（部分支持，见上） | 是否开启 profile。iOS 和 Android 端默认开启，其他端暂不支持。开启后可在接口回调的 res.profile 中查看性能调试信息。<br/> |
+| enableQuic | boolean | 否 |  | 微信小程序 4.41（部分支持，见上） | 需要基础库： `2.10.4`<br/><br/>是否开启 Quic/h3 协议（iOS 微信目前使用 gQUIC-Q43；Android 微信在 v8.0.54 前使用 gQUIC-Q43，v8.0.54 开始使用 IETF QUIC，即 h3 协议；PC微信使用 IETF QUIC，即 h3 协议）<br/> | 
+
+#### DownloadFileSuccess 的属性值 @downloadfilesuccess-values 
+
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| tempFilePath | string | 是 | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 临时文件路径，下载后的文件会存储到一个临时文件 |
+| statusCode | number | 是 | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 开发者服务器返回的 HTTP 状态码 |
+| filePath | string | 否 | 微信小程序 4.41（部分支持，见上） | 用户文件路径 (本地路径)。传入 filePath 时会返回，跟传入的 filePath 一致<br/> |
+| profile | **DownloadFileSuccessProfile** | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `2.10.4`<br/><br/>网络请求过程中一些调试信息，[查看详细说明](https://developers.weixin.qq.com/miniprogram/dev/framework/performance/network.html)。目前 iOS 和 Android 端支持。<br/> |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| SSLconnectionEnd | number | 否 | 微信小程序 4.41（部分支持，见上） | SSL建立完成的时间,如果不是安全连接,则值为 0<br/> |
+| SSLconnectionStart | number | 否 | 微信小程序 4.41（部分支持，见上） | SSL建立连接的时间,如果不是安全连接,则值为 0<br/> |
+| connectEnd | number | 否 | 微信小程序 4.41（部分支持，见上） | HTTP（TCP） 完成建立连接的时间（完成握手），如果是持久连接，则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接，则这里显示的是新建立的连接完成的时间。注意这里握手结束，包括安全连接建立完成、SOCKS 授权通过<br/> |
+| connectStart | number | 否 | 微信小程序 4.41（部分支持，见上） | HTTP（TCP） 开始建立连接的时间，如果是持久连接，则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接，则这里显示的是新建立的连接开始的时间<br/> |
+| domainLookUpEnd | number | 否 | 微信小程序 4.41（部分支持，见上） | Local DNS 域名查询完成的时间，如果使用了本地缓存（即无 DNS 查询）或持久连接，则与 fetchStart 值相等<br/> |
+| domainLookUpStart | number | 否 | 微信小程序 4.41（部分支持，见上） | Local DNS 域名查询开始的时间，如果使用了本地缓存（即无 DNS 查询）或持久连接，则与 fetchStart 值相等<br/> |
+| downstreamThroughputKbpsEstimate | number | 否 | 微信小程序 4.41（部分支持，见上） | 评估当前网络下载的kbps<br/> |
+| estimate_nettype | number | 否 | 微信小程序 4.41（部分支持，见上） | 评估的网络状态 unknown, offline, slow 2g, 2g, 3g, 4g, last/0, 1, 2, 3, 4, 5, 6<br/> |
+| fetchStart | number | 否 | 微信小程序 4.41（部分支持，见上） | 组件准备好使用 HTTP 请求抓取资源的时间，这发生在检查本地缓存之前<br/> |
+| httpDNSDomainLookUpEnd | number | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `3.8.9`<br/><br/>httpDNS 完成查询的时间。仅当开启 httpDNS 功能时返回该字段。目前仅wx.request接口支持<br/> |
+| httpDNSDomainLookUpStart | number | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `3.8.9`<br/><br/>httpDNS 开始查询的时间。仅当开启 httpDNS 功能时返回该字段。目前仅wx.request接口支持<br/> |
+| httpRttEstimate | number | 否 | 微信小程序 4.41（部分支持，见上） | 协议层根据多个请求评估当前网络的 rtt（仅供参考）<br/> |
+| invokeStart | number | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `3.8.10`<br/><br/>调用接口的时间。<br/> |
+| peerIP | string | 否 | 微信小程序 4.41（部分支持，见上） | 当前请求的IP<br/> |
+| port | number | 否 | 微信小程序 4.41（部分支持，见上） | 当前请求的端口<br/> |
+| protocol | string | 否 | 微信小程序 4.41（部分支持，见上） | 使用协议类型，有效值：http1.1, h2, quic, unknown<br/> |
+| queueEnd | number | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `3.8.10`<br/><br/>结束排队的时间。达到并行上限时才需要排队。如果未发生排队，则该字段和 queueStart 字段值相同<br/> |
+| queueStart | number | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `3.8.10`<br/><br/>开始排队的时间。达到并行上限时才需要排队。<br/> |
+| receivedBytedCount | number | 否 | 微信小程序 4.41（部分支持，见上） | 收到字节数<br/> |
+| redirectEnd | number | 否 | 微信小程序 4.41（部分支持，见上） | 最后一个 HTTP 重定向完成时的时间。有跳转且是同域名内部的重定向才算，否则值为 0<br/> |
+| redirectStart | number | 否 | 微信小程序 4.41（部分支持，见上） | 第一个 HTTP 重定向发生时的时间。有跳转且是同域名内的重定向才算，否则值为 0<br/> |
+| requestEnd | number | 否 | 微信小程序 4.41（部分支持，见上） | HTTP请求读取真实文档结束的时间<br/> |
+| requestStart | number | 否 | 微信小程序 4.41（部分支持，见上） | HTTP请求读取真实文档开始的时间（完成建立连接），包括从本地读取缓存。连接错误重连时，这里显示的也是新建立连接的时间<br/> |
+| responseEnd | number | 否 | 微信小程序 4.41（部分支持，见上） | HTTP 响应全部接收完成的时间（获取到最后一个字节），包括从本地读取缓存<br/> |
+| responseStart | number | 否 | 微信小程序 4.41（部分支持，见上） | HTTP 开始接收响应的时间（获取到第一个字节），包括从本地读取缓存<br/> |
+| rtt | number | 否 | 微信小程序 4.41（部分支持，见上） | 当次请求连接过程中实时 rtt<br/> |
+| sendBytesCount | number | 否 | 微信小程序 4.41（部分支持，见上） | 发送的字节数<br/> |
+| socketReused | boolean | 否 | 微信小程序 4.41（部分支持，见上） | 是否复用连接<br/> |
+| throughputKbps | number | 否 | 微信小程序 4.41（部分支持，见上） | 当前网络的实际下载kbps<br/> |
+| transportRttEstimate | number | 否 | 微信小程序 4.41（部分支持，见上） | 传输层根据多个请求评估的当前网络的 rtt（仅供参考）<br/> |
+| usingHighPerformanceMode | boolean | 否 | 微信小程序 4.41（部分支持，见上） | 是否走到了高性能模式。基础库 v3.3.4 起支持。<br/> |
+
+#### DownloadFileFail 的属性值 @downloadfilefail-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errCode | number | 是 | 错误码 |
+| 合法值 | 描述 |
+| :- | :- |
+| 5 | 接口超时 |
+| 1000 | 服务端系统错误 |
+| 100001 | json数据解析错误 |
+| 100002 | 错误信息json解析失败 |
+| 100003 | json解析类型转换失败 |
+| 600003 | 网络中断 |
+| 600008 | data参数类型不合法 |
+| 600009 | URL格式不合法 |
+| 600010 | Cronet模块加载失败 |
+| 602001 | request系统错误 |
+| errSubject | string | 是 | 统一错误主题（模块）名称 |
+| data | any | 否 | 错误信息中包含的数据 |
+| cause | Error | 否 | 源错误信息，可以包含多个错误，详见SourceError |
+| errMsg | string | 是 |  |
+
+### 注意事项
+
+* 当目录下有同名文件时，文件名会增加数字后缀，例如：目录下abc.txt已经存在，此时下载此文件名的文件到此目录时，下载后的文件会命名为abc(1).txt。
+* App-Android下载的默认目录为外置应用沙盒目录下的cache目录。如果手机磁盘空间不足，系统清理工具会清理cache目录。
+	+ 如需主动删除下载文件，使用[uni.getFileSystemManager](get-file-system-manager.md)。
+	+ 默认下载路径为外置应用沙盒目录`uni.env.CACHE_PATH/cache/uni-download`。但在HBuilderX 3.99前有过几次变更，3.98的目录是`uni.env.CACHE_PATH/cache/uniDownloads`，而3.98之前则不在cache目录下。
+
+### 返回值 
+
+| 类型 |
+| :- |
+| [DownloadTask](#downloadtask-values) |
+
+#### DownloadTask 的方法 @downloadtask-values 
+
+#### abort(): void, @abort
+abort
+中断下载任务
+##### abort 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 3.91 | 4.11 | 4.61 |
+
+#### onProgressUpdate(callback: DownloadFileProgressUpdateCallback): void, @onprogressupdate
+onProgressUpdate
+监听下载进度变化。
+##### onProgressUpdate 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 3.91 | 4.11 | 4.61 |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| callback | (result: [OnProgressDownloadResult](#onprogressdownloadresult-values)) => void | 是 | 
+
+##### OnProgressDownloadResult 的属性值 @onprogressdownloadresult-values 
+
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| progress | number | 是 | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 下载进度百分比 |
+| totalBytesWritten | number | 是 | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 已经下载的数据长度，单位 Bytes |
+| totalBytesExpectedToWrite | number | 是 | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 预期需要下载的数据总长度，单位 Bytes |
+
+::: danger 注意事项
+- 在4.25版本iOS平台增加了Task原生对象自动销毁的逻辑，即下载完成后自动释放原生的Task对象，建议开发者在`complete`回调中置空Task对象，例
+
+```typescript
+let task : DownloadTask | null = null
+
+task = uni.downloadFile({
+	url: 'https://qiniu-web-assets.dcloud.net.cn/unidoc/zh/uni-app.png',
+	complete: () => {
+		task = null
+	},
+})
+```
+
+如不释放，在调用Task对象的方法将导致控制台报错：
+`error: instance object does not exist: id:15`
+
+### 示例
+
+示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/download-file/download-file.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/download-file/download-file.uvue) 
+::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/download-file/download-file
+
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/download-file/download-file
+
+>示例
+```vue
+<template>
+  
+  <scroll-view style="flex: 1">
+  
+    <view>
+      <page-head :title="data.title"></page-head>
+      <view>
+        <view v-if="data.imageSrc">
+          <image class="img" :src="data.imageSrc" mode="aspectFit" />
+        </view>
+        <view v-else style="margin: 10px;">
+          <text class="uni-hello-text">点击按钮下载服务端示例图片（下载网络文件到本地临时目录）</text>
+          <button type="primary" @tap="downloadImage">下载</button>
+        </view>
+      </view>
+    </view>
+  
+  </scroll-view>
+  
+</template>
+
+
+<style>
+  .img {
+    margin: 0 auto;
+  }
+</style>
+
+```
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.downloadFile)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/network-file.html#downloadfile)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/download/DownloadTask.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=downloadFile&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=downloadFile&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=downloadFile&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=downloadFile&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=downloadFile)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=downloadFile&from=docs)
+- [京东小程序文档](https://mp-docs.jd.com/doc/dev/framework/-1)
+- [华为快应用文档](https://developer.huawei.com/consumer/cn/doc/quickApp-References/webview-frame-overview-0000001124793625)
+- [360小程序文档](https://mp.360.cn/doc/miniprogram/dev/#/b770a184ff1f06c6b3393a0fd1132380)
+
+## 通用类型
+
+### GeneralCallbackResult @generalcallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errMsg | string | 是 | 错误信息 |
+
+## tips
+
+- 下载后的文件，如需分享或使用三方应用打开，在Android7上需要使用FileProvider。
+- web端并不会将文件下载到文件系统内，而是保存在js的File对象内，以供其他接口（如canvas、uploadFile）使用

package/data/uniappx/api/env.md

@@ -0,0 +1,101 @@
+## uni.env
+
+环境变量
+
+uni.env提供了一些环境变量，主要是App和小程序文件系统相关的。理解这些环境需要参考文档：[文件系统](./file-system-spec.md)
+
+### env 的属性值 @env-values 
+
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| USER_DATA_PATH | string | 是 | Web x / 微信小程序 4.41 / Android 3.99 / iOS 4.11 / HarmonyOS 4.61（部分支持，见上） | 文件系统中的用户文件目录路径 |
+| CACHE_PATH | string | 是 | Web x / 微信小程序 x / Android 3.99 / iOS 4.11 / HarmonyOS 4.61（部分支持，见上） | 文件系统中的缓存文件目录路径 |
+| SANDBOX_PATH | string | 是 | Web x / 微信小程序 x / Android 3.99 / iOS 4.11 / HarmonyOS 4.61（部分支持，见上） | 文件系统中的应用沙盒目录路径 |
+| TEMP_PATH | string | 是 | Web x / 微信小程序 x / Android x / iOS x / HarmonyOS 4.62（部分支持，见上） | 文件系统中的应用临时目录路径，应用退出自动清理 |
+| ANDROID_INTERNAL_SANDBOX_PATH | string | 是 | Web x / 微信小程序 x / Android 3.99 / iOS x / HarmonyOS x（部分支持，见上） | 文件系统中的应用内置沙盒目录路径（仅app-android平台支持） |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.env)
+- [微信小程序文档](https://developers.weixin.qq.com/doc/search.html?source=enter&query=env&doc_type=miniprogram)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=env&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=env&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=env&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=env&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=env)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=env&from=docs)
+- [京东小程序文档](https://mp-docs.jd.com/doc/dev/framework/-1)
+- [华为快应用文档](https://developer.huawei.com/consumer/cn/doc/quickApp-References/webview-frame-overview-0000001124793625)
+- [360小程序文档](https://mp.360.cn/doc/miniprogram/dev/#/b770a184ff1f06c6b3393a0fd1132380)
+
+### 示例
+
+示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/env/env.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/env/env.uvue) 
+>
+> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 
+
+::: preview
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/env/env
+```uvue
+<template>
+  <view style="margin:12px">
+    <page-head title="环境变量 - 文件系统"></page-head>
+    <page-intro content="本页演示 uni.env 文件系统路径：点击按钮查看 USER_DATA_PATH、CACHE_PATH、SANDBOX_PATH 等目录信息，可开关递归获取。"></page-intro>
+    <button class="button" type="primary" @tap="getDirInfo(uni.env.USER_DATA_PATH)">USER_DATA_PATH</button>
+    <button class="button" type="primary" @tap="getDirInfo(data.cachePath)">CACHE_PATH</button>
+    <button class="button" type="primary" @tap="getDirInfo(data.sandboxPath)">SANDBOX_PATH</button>
+    
+    <button class="button" type="primary" @tap="getDirInfo(data.tempPath)">TEMP_PATH</button>
+    
+    
+   <button class="button" type="primary" @tap="getDirInfo(data.androidInternalSandboxPath)">ANDROID_INTERNAL_SANDBOX_PATH</button>
+    
+    <boolean-data :defaultValue="false" title="是否递归获取" @change="switchRecursive"></boolean-data>
+  </view>
+  <scroll-view style="flex: 1; padding: 16px 0px;">
+    <text class="result">{{data.result}}</text>
+    <text class="error">{{data.error}}</text>
+    <view class="stat" v-for="(stat,index) in data.list" :key="index" >
+      <text class="path">{{stat.path}}</text>
+      <text class="size">{{stat.size}}</text>
+    </view>
+  </scroll-view>
+</template>
+
+
+
+<style>
+  .button {
+    margin-bottom: 4px;
+    white-space: nowrap;
+    text-overflow: ellipsis;
+  }
+  .result {
+    font-size: 18px;
+    font-weight: bold;
+    text-align: center;
+    width: 100%;
+  }
+  .error {
+    color: firebrick;
+  }
+  .stat {
+    padding: 8px 16px;
+  }
+  .path {
+    color: darkgray;
+  }
+  .size {
+    color: darkgrey;
+  }
+</style>
+
+```
+
+## 通用类型
+
+### GeneralCallbackResult @generalcallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errMsg | string | 是 | 错误信息 |

package/data/uniappx/api/event-bus.md

@@ -0,0 +1,184 @@
+::: sourceCode
+## uni.$on(eventName, callback) @$on
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-event
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-event
+
+监听自定义事件。事件可以由 uni.$emit 触发。回调函数会接收 uni.$emit 传递的参数。
+4.31+ 开始支持返回事件监听器 id, 用于 off 事件监听器。
+
+### $on 兼容性  
+| Web | 微信小程序 | Android | iOS | iOS(VDOM) UTS 插件 | HarmonyOS |
+| :- | :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 3.91 | 4.11 | 4.31 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 描述 |
+| :- | :- | :- | :- |
+| eventName | string | 是 | 事件名称 |
+| callback | (...args?: any) => any | 是 | 事件回调 |
+
+### 返回值 
+
+| 类型 |
+| :- |
+| number |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.eventBus.$on)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/window/communication.html#on)
+
+::: sourceCode
+## uni.$off(eventName, callback?) @$off
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-event
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-event
+
+移除自定义事件监听器。如果提供了事件名和回调，则只移除这个回调的监听器。
+4.13+ 开始支持第二个参数为可选，如果仅提供事件名，则移除该事件的所有监听器。
+4.31+ 开始第二个参数的类型由 `Function | null` 调整为 `any | null`, 支持传入 `uni.$on`、`uni.$once` 返回的事件监听器 id, 移除指定事件监听器。
+
+### $off 兼容性  
+| Web | 微信小程序 | Android | iOS | iOS(VDOM) UTS 插件 | HarmonyOS |
+| :- | :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 3.91 | 4.11 | 4.31 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 描述 |
+| :- | :- | :- | :- |
+| eventName | string | 是 | 事件名称 |
+| callback | any | 否 | 要移除的事件回调或事件监听器 id |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.eventBus.$off)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/window/communication.html#off)
+
+::: sourceCode
+## uni.$once(eventName, callback) @$once
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-event
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-event
+
+监听一个自定义事件。事件只触发一次，在第一次触发之后移除事件监听器。
+4.31+ 开始支持返回事件监听器 id, 用于 off 事件监听器。
+
+### $once 兼容性  
+| Web | 微信小程序 | Android | iOS | iOS(VDOM) UTS 插件 | HarmonyOS |
+| :- | :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 3.91 | 4.11 | 4.31 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 描述 |
+| :- | :- | :- | :- |
+| eventName | string | 是 | 事件名称 |
+| callback | (...args?: any) => any | 是 | 事件回调 |
+
+### 返回值 
+
+| 类型 |
+| :- |
+| number |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.eventBus.$once)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/window/communication.html#once)
+
+::: sourceCode
+## uni.$emit(eventName, args?) @$emit
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-event
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-event
+
+触发自定义事件，附加的参数会传递给事件监听器。
+在iOS平台UTS环境下或者UTS和JS通信时参数仅支持基础类型、string、Array、UTSJSONObject,其中Array，UTSJSONObject也仅支持包含上述类型,on和emit类型需匹配否则会产生异常
+
+### $emit 兼容性  
+| Web | 微信小程序 | Android | iOS | iOS(VDOM) UTS 插件 | HarmonyOS |
+| :- | :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 3.91 | 4.11 | 4.31 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 描述 |
+| :- | :- | :- | :- |
+| eventName | string | 是 | 事件名称 |
+| args | Array<any> | 否 | 触发事件时传递的参数 |
+
+参数 `args` 为对象字面量时，4.25 前需要通过 `as` 明确类型，例如：
+```js
+uni.$emit('fn', {"a": 1} as UTSJSONObject)
+```
+4.25+ 编译器会自动将对象字面量推断为 `UTSJSONObject` 类型，不再需要通过 `as` 明确类型。如果需要传递其他自定义类型的对象字面量，仍需要通过 `as` 明确类型。
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.eventBus.$emit)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/window/communication.html#emit)
+
+## 示例
+
+示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/event-bus/event-bus.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/event-bus/event-bus.uvue) 
+::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/event-bus/event-bus
+
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/event-bus/event-bus
+
+>示例
+```vue
+<template>
+  
+  <scroll-view class="page-scroll-view">
+    
+    <view class="box">
+      <button class="uni-btn" @click="on">开始监听</button>
+      <button class="uni-btn" @click="once">监听一次</button>
+      <button class="uni-btn" @click="off">取消监听</button>
+      
+      <button class="uni-btn" @click="emit">触发监听</button>
+      <button class="uni-btn" @click="clear">清空消息</button>
+      <view>
+        <view class="uni-btn">收到的消息：</view>
+        <view class="uni-btn">
+          <view v-for="(item, index) in data.log" :key="index">{{ item }}</view>
+        </view>
+        <button class="uni-btn" @click="onObj">开始监听 obj 参数</button>
+        <button class="uni-btn" @click="emitWithObj">触发监听 obj 参数</button>
+        <view class='uni-btn'>
+          <text>接收到的 obj 参数：</text>
+          <text>{{ JSON.stringify(data.objArg) }}</text>
+        </view>
+        <button class='uni-btn' @click="testReturnId">测试返回 id</button>
+        <button class='uni-btn' @click="testEmitNoArgs">测试 $emit 无参</button>
+        <button class='uni-btn' @click="testEmitMultipleArgs">测试 $emit 多个参数</button>
+      </view>
+    </view>
+    
+  </scroll-view>
+  
+</template>
+
+
+
+<style>
+.box {
+  padding: 10px;
+}
+</style>
+
+```
+
+## 通用类型
+
+### GeneralCallbackResult @generalcallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errMsg | string | 是 | 错误信息 |
+
+## Tips
+* - `eventName` 应避免使用 `uni` 开头，以免与 uni-app x 内置事件冲突

package/data/uniappx/api/exit.md

@@ -0,0 +1,134 @@
+::: sourceCode
+## uni.exit(options?) @exit
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-exit
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-exit
+
+退出当前应用
+
+### exit 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | 3.91 | 4.33 | 4.71 |
+
+#### app平台差异
+
+##### app-android平台
+Android平台的应用退出分热退出和冷退出。
+- 冷退出是彻底杀掉
+- 热退出是关闭可见的activity，后台进程不退出（比如push）
+
+基本上主流Android App都是热退出。本API也是热退出。
+
+热退出，即通知了os：这个App用户不用了，在os需要时可以回收。如果在os回收之前，用户又启动这个App，会感觉启动速度更快一些。
+
+[uni-app x 原生SDK](../native/README.md)模式中调用本API仅会关闭uni-app x应用。不会关闭宿主应用。
+
+##### app-ios平台
+iOS系统自身并没有退出应用的API。
+
+[uni-app x 原生SDK](../native/README.md)模式中支持通过本API关闭uni-app x应用。
+
+##### app-harmony平台
+在鸿蒙平台退出时会结束当前 Ability，应用会在最近任务列表中保留快照 [文档](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-inner-application-uiabilitycontext#terminateself) /
+如果需要在停止 UIAbility 时，清理任务中心的相关任务（即不保留最近任务列表中的快照），需要在 [module.json5](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/module-configuration-file) 配置文件中将 `removeMissionAfterTerminate` 字段取值配置为 `true`。
+
+[uni-app x 原生SDK](../native/README.md)模式时通过本API关闭uni-app x应用仅会关闭uni-app x实例，不会销毁所在的Ability。
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| options | **ExitOptions** | 否 | Web x / 微信小程序 x（部分支持，见上） | uni.exit参数定义 |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| success | (res: [ExitSuccess](#exitsuccess-values)) => void | 否 | Web x / 微信小程序 x（部分支持，见上） | uni.exit成功回调函数定义 |
+| fail | (res: [ExitFail](#exitfail-values)) => void | 否 | Web x / 微信小程序 x（部分支持，见上） | uni.exit失败回调函数定义 |
+| complete | (res: any) => void | 否 | Web x / 微信小程序 x（部分支持，见上） | uni.exit完成回调函数定义 | 
+
+#### ExitSuccess 的属性值 @exitsuccess-values 
+
+| 名称 | 类型 | 必备 | 兼容性 |
+| :- | :- | :- |  :-: |
+| errMsg | string | 是 | Web x / 微信小程序 x（部分支持，见上） |
+
+#### ExitFail 的属性值 @exitfail-values 
+
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| errCode | number | 是 | Web x / 微信小程序 x（部分支持，见上） | 错误码 |
+| 合法值 | 兼容性 | 描述 |
+| :- |  :-: | :- |
+| 12001 | Web x / 微信小程序 x（部分支持，见上） | 系统不支持 |
+| 12002 | Web x / 微信小程序 x（部分支持，见上） | 未知错误 |
+| 12003 | Web x / 微信小程序 x（部分支持，见上） | iOS平台，仅在uni-app x SDK模式中支持应用退出 |
+| errSubject | string | 是 | Web x / 微信小程序 x（部分支持，见上） | 统一错误主题（模块）名称 |
+| data | any | 否 | Web x / 微信小程序 x（部分支持，见上） | 错误信息中包含的数据 |
+| cause | Error | 否 |   | 源错误信息，可以包含多个错误，详见SourceError |
+| errMsg | string | 是 | Web x / 微信小程序 x（部分支持，见上） |  |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.exit)
+- [微信小程序文档](https://developers.weixin.qq.com/doc/search.html?source=enter&query=exit&doc_type=miniprogram)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=exit&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=exit&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=exit&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=exit&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=exit)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=exit&from=docs)
+- [京东小程序文档](https://mp-docs.jd.com/doc/dev/framework/-1)
+- [华为快应用文档](https://developer.huawei.com/consumer/cn/doc/quickApp-References/webview-frame-overview-0000001124793625)
+- [360小程序文档](https://mp.360.cn/doc/miniprogram/dev/#/b770a184ff1f06c6b3393a0fd1132380)
+
+### 示例
+
+示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/exit/exit.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/exit/exit.uvue) 
+>
+> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 
+
+::: preview
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/exit/exit
+```uvue
+<template>
+  <view>
+    <button @tap="exitAppClick">退出应用</button>
+    <text>注:iOS仅在uni-app x SDK模式中支持应用退出</text>
+  </view>
+</template>
+
+
+
+<style>
+
+</style>
+
+```
+
+## 切换应用到后台@back
+
+### Android
+
+有的Android App，点back后不询问用户，直接隐藏到了后台。这种做法占用手机的资源一些，但确实也有一些App是这么做的。
+
+Android的activity提供了将应用切换到后台的方法：
+```ts
+// #ifdef APP-ANDROID
+	UTSAndroid.getUniActivity()?.moveTaskToBack(true)
+// #endif
+```
+
+### HarmonyOS
+在鸿蒙平台可以通过 Ability 的 `moveAbilityToBackground` 方法将应用切换到后台：
+```ts
+UTSHarmony.getUIAbilityContext().moveAbilityToBackground()
+```
+
+## 通用类型
+
+### GeneralCallbackResult @generalcallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errMsg | string | 是 | 错误信息 |