tmui-cli 2.0.3 → 2.0.5

package/data/uniappx/api/request.md

@@ -0,0 +1,518 @@
+::: sourceCode
+## uni.request(param) @request
+
+> 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
+
+发起网络请求。
+
+### request 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 3.91 | 4.11 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 描述 |
+| :- | :- | :- | :- |
+| param | **RequestOptions** | 是 | 网络请求参数 |
+| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
+| :- | :- | :- | :- |  :-: | :- |
+| url | string | 是 |  | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 开发者服务器接口地址<br/> |
+| data | any | 否 | null | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 请求的参数 在app-android端，参数类型只能为`UTSJSONObject`或者`string`类型,app-android平台从 4.51版本开始支持ArrayBuffer, app-ios平台从 4.61版本开始支持ArrayBuffer |
+| header | UTSJSONObject | 否 | null | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 设置请求的 header，header 中不能设置 Referer |
+| method | string | 否 | "GET" | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 请求方法 |
+@@| 合法值 | 兼容性 | 描述 |
+@@| :- |  :-: | :- |
+@@| "GET" |   | GET方法请求一个指定资源的表示形式，使用 GET 的请求应该只被用于获取数据。 |
+@@| POST |   | POST方法用于将实体提交到指定的资源，通常导致在服务器上的状态变化或副作用。 |
+@@| PUT |   | PUT方法用有效载荷请求替换目标资源的所有当前表示。 |
+@@| PATCH |   | PATCH方法用于对资源应用部分修改。 |
+@@| DELETE |   | DELETE方法删除指定的资源。 |
+@@| HEAD |   | HEAD方法请求一个与GET请求的响应相同的响应，但没有响应体。 |
+@@| OPTIONS |   | OPTIONS 方法用于描述目标资源的通信选项。 |
+@@| TRACE | 微信小程序 4.41（部分支持，见上） |  |
+@@| CONNECT | 微信小程序 4.41（部分支持，见上） |  |
+| timeout | number | 否 | 60000 | 微信小程序 4.41 / Android 3.91 / iOS 4.11（部分支持，见上） | 超时时间，单位 ms |
+| enableQuic | boolean | 否 | false | Web √ / 微信小程序 √ / Android 5.0 / iOS 5.0 / HarmonyOS 5.0 | 是否开启 Quic/h3 协议<br/>`web` 端由服务端和浏览器共同决定是否启用 Quic/h3 协议，无需设置此参数<br/> `Android`端从`HBuilderX 5.23`开始，默认开启Brotli |
+| dataType | string | 否 | "json" | 微信小程序 4.41 / Android x / iOS x / HarmonyOS x（部分支持，见上） | 如果设为 json，会对返回的数据进行一次 JSON.parse，非 json 不会进行 JSON.parse |
+| responseType | string | 否 |  | 微信小程序 4.41 / Android x / iOS x / HarmonyOS x（部分支持，见上） | 设置响应的数据类型。 |
+| sslVerify | boolean | 否 |  | Android x / iOS x / HarmonyOS x（部分支持，见上） | 验证 ssl 证书 |
+| withCredentials | boolean | 否 |  | Web 4.0 / 微信小程序 4.41 / Android x / iOS x / HarmonyOS x（部分支持，见上） | 跨域请求时是否携带凭证（cookies）<br/> |
+| firstIpv4 | boolean | 否 | false | Web x / 微信小程序 4.41 / Android x / iOS x / HarmonyOS x（部分支持，见上） | DNS解析时优先使用ipv4 |
+| enableChunked | boolean | 否 |  | Web 4.71 / 微信小程序 4.41 / Android 4.71 / iOS 4.71 / HarmonyOS 4.71 | 开启 transfer-encoding chunked。 |
+| success | (option: [RequestSuccess](#requestsuccess-values)) => void | 否 | null | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 网络请求成功回调。 |
+| fail | (option: [RequestFail](#requestfail-values)) => void | 否 | null | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 网络请求失败回调。 |
+| complete | (option: any) => void | 否 | null | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 网络请求完成回调，成功或者失败都会调用。 |
+| enableCache | boolean | 否 |  | 微信小程序 4.41（部分支持，见上） | 需要基础库： `2.10.4`<br/><br/>开启 Http 缓存<br/> |
+| enableHttp2 | boolean | 否 |  | 微信小程序 4.41（部分支持，见上） | 需要基础库： `2.10.4`<br/><br/>开启 http2<br/> |
+| enableHttpDNS | boolean | 否 |  | 微信小程序 4.41（部分支持，见上） | 需要基础库： `2.19.1`<br/><br/>是否开启 HttpDNS 服务。如开启，需要同时填入 httpDNSServiceId 。 HttpDNS 用法详见 [移动解析HttpDNS](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/HTTPDNS.html)<br/> |
+| enableHttpDNSFallback | boolean | 否 |  | 微信小程序 4.41（部分支持，见上） | 需要基础库： `3.16.2`<br/><br/>是否开启 HttpDNS 兜底。开启时，HttpDNS 服务查询失败会回退到 localDNS；关闭时，HttpDNS 服务查询失败将直接报错，不回退到 localDNS。默认为 true。 HttpDNS 用法详见 [移动解析HttpDNS](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/HTTPDNS.html)<br/> |
+| enableProfile | boolean | 否 |  | 微信小程序 4.41（部分支持，见上） | 是否开启 profile。iOS 和 Android 端默认开启，其他端暂不支持。开启后可在接口回调的 res.profile 中查看性能调试信息。<br/> |
+| forceCellularNetwork | boolean | 否 |  | 微信小程序 4.41（部分支持，见上） | 需要基础库： `2.21.0`<br/><br/>强制使用蜂窝网络发送请求<br/> |
+| httpDNSServiceId | string | 否 |  | 微信小程序 4.41（部分支持，见上） | 需要基础库： `2.19.1`<br/><br/>HttpDNS 服务商 Id。 HttpDNS 用法详见 [移动解析HttpDNS](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/HTTPDNS.html)<br/> |
+| httpDNSTimeout | number | 否 |  | 微信小程序 4.41（部分支持，见上） | 需要基础库： `3.8.9`<br/><br/>HttpDNS 超时时间。HttpDNS解析时间超过该值时不再走HttpDNS，本次请求将回退到localDNS。默认为 60000 毫秒。 HttpDNS 用法详见 [移动解析HttpDNS](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/HTTPDNS.html)<br/> |
+| redirect | string | 否 |  | 微信小程序 4.41（部分支持，见上） | 需要基础库： `3.2.2`<br/><br/>重定向拦截策略。（目前安卓、iOS、开发者工具已支持，PC端将在后续支持）<br/><br/>可选值：<br/>- 'follow': 不拦截重定向，即客户端自动处理重定向;<br/>- 'manual': 拦截重定向。开启后，当 http 状态码为 3xx 时客户端不再自动重定向，而是触发 onHeadersReceived 回调，并结束本次 request 请求。可通过 onHeadersReceived 回调中的 header.Location 获取重定向的 url;<br/> |
+@@| 合法值 |
+@@| :- |
+@@| follow |
+@@| manual |
+| useHighPerformanceMode | boolean | 否 |  | 微信小程序 4.41（部分支持，见上） | 需要基础库： `3.3.3`<br/><br/>使用高性能模式。从基础库 v3.5.0 开始在 Android 端默认开启，其他端暂不生效。该模式下有更优的网络性能表现，更多信息请查看下方说明。<br/> | 
+
+#### RequestSuccess 的属性值 @requestsuccess-values 
+
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| data | T | 否 | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 开发者服务器返回的数据, app-android平台从 4.51版本开始支持ArrayBuffer, app-ios平台从 4.61版本开始支持ArrayBuffer |
+| statusCode | number | 是 | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 开发者服务器返回的 HTTP 状态码 |
+| header | any | 是 | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 开发者服务器返回的 HTTP Response Header |
+| cookies | Array&lt;string&gt; | 是 | Web x / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61（部分支持，见上） | 开发者服务器返回的 cookies，格式为字符串数组 |
+| exception | **RequestSuccessException** | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `3.0.0`<br/><br/>网络请求过程中的一些异常信息，例如httpdns超时等<br/> |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| reasons | any | 否 | 微信小程序 4.41（部分支持，见上） | 本次请求底层失败信息，所有失败信息均符合Errno错误码<br/> |
+| retryCount | number | 否 | 微信小程序 4.41（部分支持，见上） | 本次请求底层重试次数<br/> |
+| profile | **RequestSuccessProfile** | 否 | 微信小程序 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/> |
+| useHttpDNS | boolean | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `3.4.10`<br/><br/>最终请求是否使用了HttpDNS解析的IP。仅当enableHttpDNS传true时返回此字段。如果开启enableHttpDNS但最终请求未使用HttpDNS解析的IP，可在exception查看原因。<br/> |
+
+#### RequestFail 的属性值 @requestfail-values 
+
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| errCode | number | 是 |   | 错误码 |
+| 合法值 | 描述 |
+| :- | :- |
+| 5 | 接口超时 |
+| 1000 | 服务端系统错误 |
+| 100001 | json数据解析错误 |
+| 100002 | 错误信息json解析失败 |
+| 100003 | json解析类型转换失败 |
+| 600003 | 网络中断 |
+| 600008 | data参数类型不合法 |
+| 600009 | URL格式不合法 |
+| 600010 | Cronet模块加载失败 |
+| 602001 | request系统错误 |
+| errno | number | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `2.24.0`<br/><br/>errno 错误码，错误码的详细说明参考 [Errno错误码](https://developers.weixin.qq.com/miniprogram/dev/framework/usability/PublicErrno.html)<br/> |
+| exception | **RequestFailException** | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `3.8.10`<br/><br/>网络请求过程中的一些异常信息，例如httpdns超时等<br/> |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| reasons | any | 否 | 微信小程序 4.41（部分支持，见上） | 本次请求底层失败信息，所有失败信息均符合Errno错误码<br/> |
+| retryCount | number | 否 | 微信小程序 4.41（部分支持，见上） | 本次请求底层重试次数<br/> |
+| useHttpDNS | boolean | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `3.8.10`<br/><br/>最终请求是否使用了HttpDNS解析的IP。仅当enableHttpDNS传true时返回此字段。如果开启enableHttpDNS但最终请求未使用HttpDNS解析的IP，可在exception查看原因。<br/> |
+| errSubject | string | 是 |   | 统一错误主题（模块）名称 |
+| data | any | 否 |   | 错误信息中包含的数据 |
+| cause | Error | 否 |   | 源错误信息，可以包含多个错误，详见SourceError |
+| errMsg | string | 是 |   |  |
+
+### 返回值 
+
+| 类型 |
+| :- |
+| [RequestTask](#requesttask-values) |
+
+#### RequestTask 的方法 @requesttask-values 
+
+#### abort(): void @abort
+abort
+中断网络请求。
+##### abort 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 3.91 | 4.11 | 4.61 |
+
+#### onChunkReceived(listener: RequestTaskOnChunkReceivedCallback): number @onchunkreceived
+onChunkReceived
+监听 Transfer-Encoding Chunk Received 事件。
+##### onChunkReceived 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.71 | 4.41 | 4.71 | 4.71 | 4.71 |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| listener | (result: [RequestTaskOnChunkReceivedListenerResult](#requesttaskonchunkreceivedlistenerresult-values)) => void | 是 | 
+
+##### RequestTaskOnChunkReceivedListenerResult 的属性值 @requesttaskonchunkreceivedlistenerresult-values 
+
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| data | ArrayBuffer | 是 | Web 4.71 / 微信小程序 4.41 / Android 4.71 / iOS 4.71 / HarmonyOS 4.71 | 返回的chunk buffer |
+
+##### 返回值 
+
+| 类型 |
+| :- |
+| number |
+ 
+
+#### offChunkReceived(listener?: number \| RequestTaskOnChunkReceivedCallback): void @offchunkreceived
+offChunkReceived
+移除 Transfer-Encoding Chunk Received 事件的监听函数。
+##### offChunkReceived 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.71 | 4.41 | 4.71 | 4.71 | 4.71 |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| listener | number \| (result: **RequestTaskOnChunkReceivedListenerResult**) => void | 否 |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| data | ArrayBuffer | 是 | Web 4.71 / 微信小程序 4.41 / Android 4.71 / iOS 4.71 / HarmonyOS 4.71 | 返回的chunk buffer | 
+
+#### onHeadersReceived(listener: RequestTaskOnHeadersReceivedCallback): number @onheadersreceived
+onHeadersReceived
+监听 HTTP Response Header 事件。
+##### onHeadersReceived 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.71 | 4.41 | 4.71 | 4.71 | 4.71 |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 | 描述 |
+| :- | :- | :- | :- |
+| listener | (result: [RequestTaskOnHeadersReceivedListenerResult](#requesttaskonheadersreceivedlistenerresult-values)) => void | 是 | HTTP Response Header 事件的监听函数 | 
+
+##### RequestTaskOnHeadersReceivedListenerResult 的属性值 @requesttaskonheadersreceivedlistenerresult-values 
+
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| cookies | Array&lt;string&gt; | 是 | Web 4.71 / 微信小程序 4.41 / Android 4.71 / iOS 4.71 / HarmonyOS 4.71 | 开发者服务器返回的 cookies，格式为字符串数组 |
+| header | UTSJSONObject | 是 | Web 4.71 / 微信小程序 4.41 / Android 4.71 / iOS 4.71 / HarmonyOS 4.71 | 开发者服务器返回的 HTTP Response Header |
+| statusCode | number | 是 | Web 4.71 / 微信小程序 4.41 / Android 4.71 / iOS 4.71 / HarmonyOS 4.71 | 开发者服务器返回的 HTTP 状态码 （目前开发者工具上不会返回 statusCode 字段，可用真机查看该字段，后续将会支持） |
+
+##### 返回值 
+
+| 类型 |
+| :- |
+| number |
+ 
+
+#### offHeadersReceived(listener?: number \| RequestTaskOnHeadersReceivedCallback): void @offheadersreceived
+offHeadersReceived
+移除 HTTP Response Header 事件的监听函数。
+##### offHeadersReceived 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.71 | 4.41 | 4.71 | 4.71 | 4.71 |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| listener | number \| (result: **RequestTaskOnHeadersReceivedListenerResult**) => void | 否 |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| cookies | Array&lt;string&gt; | 是 | Web 4.71 / 微信小程序 4.41 / Android 4.71 / iOS 4.71 / HarmonyOS 4.71 | 开发者服务器返回的 cookies，格式为字符串数组 |
+| header | UTSJSONObject | 是 | Web 4.71 / 微信小程序 4.41 / Android 4.71 / iOS 4.71 / HarmonyOS 4.71 | 开发者服务器返回的 HTTP Response Header |
+| statusCode | number | 是 | Web 4.71 / 微信小程序 4.41 / Android 4.71 / iOS 4.71 / HarmonyOS 4.71 | 开发者服务器返回的 HTTP 状态码 （目前开发者工具上不会返回 statusCode 字段，可用真机查看该字段，后续将会支持） |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.request)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/request.html)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/request/RequestTask.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=request&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=request&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=request&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=request&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=request)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=request&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/request/request.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/request/request.uvue) 
+::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/request/request
+
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/request/request
+
+>示例
+```vue
+<template>
+  <view style="flex: 1;">
+    <page-intro content="本页演示 uni.request：设置请求方式（GET/POST/PUT 等）、请求地址与参数，发起请求后在上方查看返回内容；可切换错误码接口、不同 header、超时等，并展示请求任务与拦截器用法。"></page-intro>
+    <view class="uni-padding-wrap uni-common-mt">
+      <view class="uni-common-mt" style="border-width: 2px;border-style: solid; border-radius: 4px;">
+        <textarea :value="data.res" class="uni-textarea" style="width: 100%"></textarea>
+      </view>
+      <view>
+        <text>地址 : {{ data.host + data.url}}</text>
+        <text>请求方式 : {{data.method}}</text>
+      </view>
+      <view class="uni-btn-v uni-common-mt">
+        <button type="primary" @click="sendRequest">发起请求</button>
+      </view>
+    </view>
+    <scroll-view style="flex: 1;" :show-scrollbar="true">
+      <view style="padding: 20px;">
+        <text>设置请求方式</text>
+        <view class="uni-common-pb"></view>
+        <view style="flex-direction: row;flex-wrap: wrap;">
+          <button 
+            style="padding: 5px; margin-right: 10px;"
+            
+            
+            style="margin-right: 10px;"
+            
+            type="primary" size="mini"
+            @click="changeMethod('GET')">GET</button>
+          <button 
+            style="padding: 5px; margin-right: 10px; "
+            
+            
+            style="margin-right: 10px;"
+            
+            type="primary" size="mini"
+            @click="changeMethod('POST')">POST</button>
+          <button 
+            style="padding: 5px; margin-right: 10px; "
+            
+            
+            style="margin-right: 10px;"
+            
+            type="primary" size="mini"
+            @click="changeMethod('PUT')">PUT</button>
+          <button 
+            style="padding: 5px; margin-right: 10px;"
+            
+            
+            style="margin-right: 10px;"
+            
+            type="primary" size="mini"
+            @click="changeMethod('DELETE')">DELETE</button>
+          <button 
+            style="padding: 5px; margin-right: 10px; "
+            
+            
+            style="margin-right: 10px;"
+            
+            type="primary" size="mini"
+            @click="changeMethod('PATCH')">PATCH</button>
+          <button 
+            style="padding: 5px;margin-right: 10px;"
+            
+            
+            style="margin-right: 10px;"
+            
+            type="primary" size="mini"
+            @click="changeMethod('OPTIONS')">OPTIONS</button>
+          <button 
+            style="padding: 5px;"
+            
+            type="primary" size="mini" @click="changeMethod('HEAD')">HEAD</button>
+        </view>
+      </view>
+      <view style="padding: 20px;">
+        <text>请求返回错误码的接口（默认为GET）</text>
+        <view class="uni-common-pb"></view>
+        <view style="flex-direction: row;flex-wrap: wrap;">
+          <button 
+            style="padding: 5px;"
+            
+            type="primary" size="mini" v-for="(item, index) in data.errorCodeUrls" :key="index"
+            @click="changeUrl(item)">{{item}}</button>
+        </view>
+      </view>
+      <view style="padding: 20px;">
+        <text>请求不同header的接口（默认为GET）</text>
+        <view class="uni-common-pb"></view>
+        <view style="flex-direction: row;flex-wrap: wrap;">
+          <button 
+            style="padding: 5px;"
+            
+            type="primary" size="mini" v-for="(item, index) in data.headerUrls" :key="index"
+            @click="changeUrl(item)">{{item}}</button>
+        </view>
+      </view>
+      
+      <view style="padding: 20px;">
+        <text>检测请求 header 键是否为小写</text>
+        <view class="uni-common-pb"></view>
+        <button type="primary" size="mini" @click="checkHeaderLowerCase">检测 header 键小写</button>
+      </view>
+      
+      <view style="padding: 20px;">
+        <text>请求不同content-type的接口（默认为GET）</text>
+        <view class="uni-common-pb"></view>
+        <view style="flex-direction: row;flex-wrap: wrap;">
+          <button 
+            style="padding: 5px;"
+            
+            type="primary" size="mini" v-for="(item, index) in data.contentTypeUrls" :key="index"
+            @click="changeUrl(item)">{{item}}</button>
+        </view>
+      </view>
+
+      <view style="padding: 20px;">
+        <text>POST请求(有body)</text>
+        <view class="uni-common-pb"></view>
+        <view style="flex-direction: row;flex-wrap: wrap;">
+          <button 
+            style="padding: 5px;"
+            
+            type="primary" size="mini" v-for="(item, index) in data.postUrls" :key="index"
+            @click="changeUrlFromPost(item)">{{item}}</button>
+        </view>
+      </view>
+      
+      <view style="padding: 20px;">
+        <text>ArrayBuffer 测试</text>
+        <view class="uni-common-pb"></view>
+        <view style="flex-direction: row;flex-wrap: wrap;">
+          <button 
+            style="padding: 5px;"
+            
+            type="primary" size="mini"
+            @click="sendArrayBuffer(false)">请求body为ArrayBuffer，response也为ArrayBuffer</button>
+          <button 
+            style="padding: 5px;"
+            
+            type="primary" size="mini"
+            @click="sendArrayBuffer(true)">请求response为ArrayBuffer</button>
+        </view>
+      </view>
+      
+
+      <view style="padding: 20px;">
+        <text>RequestTask 测试</text>
+        <view class="uni-common-pb"></view>
+        <button type="primary" @click="sendChunkRequest">流式请求</button>
+      </view>
+
+      <view style="padding: 20px;">
+        <text>enableQuic 测试</text>
+        <view class="uni-common-pb"></view>
+        <button type="primary" @click="sendH3Request">http3请求</button>
+      </view>
+
+      <view style="padding: 20px;">
+        <text>Accept-Encoding:'gzip'测试</text>
+        <view class="uni-common-pb"></view>
+        <button type="primary" @click="sendGzipRequest">Accept-Encoding:'gzip'请求</button>
+      </view>
+
+      <view style="padding: 20px;">
+        <text>检测query</text>
+        <view class="uni-common-pb"></view>
+        <button type="primary" @click="checkQuery">检测query</button>
+      </view>
+
+      <view class="uni-common-pb"></view>
+      <view class="uni-common-pb"></view>
+    </scroll-view>
+  </view>
+</template>
+
+
+<style>
+  .uni-textarea {
+    padding: 9px;
+    font-size: 14px;
+  }
+</style>
+
+```
+
+## cookie管理
+- `uni.request`、`uni.uploadFile`、`uni.downloadFile`等网络API之间支持共享cookie [Cookie共享介绍](network-summarize.md)。
+
+## 流式响应@chrunk
+
+AI大语言模型的服务器，向客户端持续的流式输出AI推理的结果文本。在客户端表现为打字机效果。
+
+在uni-app x中，实现AI聊天的方式如下：
+1. 使用uni.request，把客户端的prompt通过POST的方式发送到LLM服务器，同时设置响应体格式为arraybuffer
+2. 客户端监听onChunkReceived事件，流式接收arraybuffer数据
+3. 客户端通过TextEncoder解码出文本，一般是markdown格式。（注意小程序自身没有TextEncoder，需要再通过三方库解码）
+4. 客户端流式渲染markdown格式
+
+实现AI聊天的工作较为复杂，流式接收和渲染markdown很容易引发性能问题，处理原生的markdown解析工作量也很大。
+所以DCloud提供了开源的uni-ai x，已完整实现原生的、全端的AI聊天，[详见](https://ext.dcloud.net.cn/plugin?name=uni-ai-x)
+
+## JSON解析注意@json
+
+uni-app x的Android VDOM模式是强类型，联网获取JSON，拿到的不是js的object。
+
+默认返回的是UTSJSONObject，UTSJSONObject是UTS提供的JSON数据对象，实现了js的object的JSON相关功能，但又有区别。**如果照搬js的object用法会失败**。
+
+同时request也支持泛型，返回一个开发者自定义的type。
+
+**请不熟悉强类型的开发者务必阅读教程：**[uni-app x的Android VDOM联网教程](../tutorial/request.md)
+
+蒸汽模式时不要求强类型。
+
+## 注意事项@tips
+
+* uni-app x 5.0+，Android支持了http/3网络，加快了网络连接，但因为引入了cronet库，导致APK包体积增加了数M（具体取决于包含的CPU数量）。从HBuilderX 5.22+，manifest的Android设置中可以选择是否包含cronet库，默认不包含。
+* 拦截器在js中使用很普遍。但Android VDOM模式下编译为原生语言时由于缺少动态性，模拟实现拦截达不到js的全部效果。一般建议开发者直接使用uni.request，不封装拦截器。如仍想使用拦截器，见[插件市场](https://ext.dcloud.net.cn/search?q=%E7%BD%91%E7%BB%9C%E6%8B%A6%E6%88%AA%E5%99%A8&uni-appx=1)。蒸汽模式不存在此问题，js的拦截器可以直接用。
+* app-android平台 VDOM模式 request 接口如需包装和传递泛型，需参考[泛型传递丢失注意](../plugin/uts-for-android.md#lost-generics)。成熟的拦截器插件均已自动处理这些问题。蒸汽模式不存在此问题。
+* 如果使用泛型先创建RequestOptions实例，再传入uni.request()，此时请务必确保request要显式指定泛型，例：
+```typescript
+const options: RequestOptions<Person> = ...
+uni.request<Person>(options)
+```
+* app-android、app-ios平台 uni.request()暂未支持Promise，返回值是RequestTask。
+* app-ios平台的 RequestTask.onChunkReceived 基于原生 URLSession 实现，需要服务端必须采用「流式响应」方式——即使用 Transfer-Encoding: chunked，或以 Content-Type: text/event-stream 形式持续输出数据
+* web平台 request接口目前不支持创建传入的泛型的实例
+* web平台 request接口在 4.01版本之前返回数据是一个普通对象，4.01起调整为UTSJSONObject类型
+* 在4.25版本iOS平台增加了Task原生对象自动销毁的逻辑，即网络请求完成后自动释放原生的Task对象，建议开发者在`complete`回调中置空Task对象，例
+
+```typescript
+complete: () => {
+            this.task = null
+          },
+```
+
+如不释放，在调用Task对象的方法将导致控制台报错：
+`error: instance object does not exist: id:15`
+* Android release 包默认禁止 http 明文请求（Android 9+ targetSdkVersion≥28）。会导致联网失败。优先推荐使用 https 来解决。如果确定坚持不安全的http，那么方案如下：在项目根目录新建 AndroidManifest.xml，给 application 节点加 android:usesCleartextTraffic="true"，配置方式见 https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html
+
+## 通用类型
+
+### GeneralCallbackResult @generalcallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errMsg | string | 是 | 错误信息 |

package/data/uniappx/api/rpx2px.md

@@ -0,0 +1,94 @@
+::: sourceCode
+## uni.rpx2px(number) @rpx2px
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-rpx2px
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-rpx2px
+
+将rpx单位值转换成px
+
+### rpx2px 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.02 | 4.41 | 4.02 | 4.11 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| number | number | 是 |
+
+### 返回值 
+
+| 类型 |
+| :- |
+| number |
+
+### 示例
+
+示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/rpx2px/rpx2px.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/rpx2px/rpx2px.uvue) 
+::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/rpx2px/rpx2px
+
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/rpx2px/rpx2px
+
+>示例
+```vue
+<template>
+  
+  <scroll-view class="page-scroll-view">
+  
+    <view class="page">
+      <page-head :title="data.title"></page-head>
+      <view>
+        <view class="item">
+          <text class="item-k">输入:</text>
+          <text class="item-v">{{data.rpxValue}}rpx</text>
+        </view>
+        <view class="item">
+          <text class="item-k">返回:</text>
+          <text class="item-v">{{data.pxValue}}px</text>
+        </view>
+      </view>
+      <view>
+        <button id="convert" @click="rpx2px">转换</button>
+      </view>
+    </view>
+  
+  </scroll-view>
+  
+</template>
+
+
+<style>
+  .page {
+    padding: 15px;
+  }
+
+  .item {
+    flex-direction: row;
+  }
+
+  .item-k {
+    width: 72px;
+    line-height: 2;
+  }
+
+  .item-v {
+    font-weight: bold;
+    line-height: 2;
+  }
+</style>
+
+```
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.rpx2px)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/ui/font.html#upx2px)
+
+## 通用类型
+
+### GeneralCallbackResult @generalcallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errMsg | string | 是 | 错误信息 |