@tarojs/taro 3.5.0-canary.1 → 3.5.0

package/types/api/network/request.d.ts

@@ -2,68 +2,118 @@ import Taro from '../../index'
 
 declare module '../../index' {
   namespace request {
-    interface Option < U extends string | TaroGeneral.IAnyObject | ArrayBuffer = any | any > {
+    interface Option <T = any, U extends string | TaroGeneral.IAnyObject | ArrayBuffer = any | any > {
       /** 开发者服务器接口地址 */
       url: string
-      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 请求的参数 */
       data?: U
-      /** 返回的数据格式 */
-      dataType?: keyof dataType | string
-      /** 接口调用失败的回调函数 */
-      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 设置请求的 header，header 中不能设置 Referer。
        *
-       * `content-type` 默认为 `application/json` */
+       * `content-type` 默认为 `application/json`
+       */
       header?: TaroGeneral.IAnyObject
-      /** HTTP 请求方法 */
-      method?: keyof method
+      /** 超时时间，单位为毫秒
+       * @default 2000
+       * @supported weapp, h5, tt
+       */
+      timeout?: number
+      /** HTTP 请求方法
+       * @default GET
+       */
+      method?: keyof Method
+      /** 返回的数据格式 */
+      dataType?: keyof DataType | string
       /** 响应的数据类型 */
-      responseType?: keyof responseType
+      responseType?: keyof ResponseType
+      /** 开启 http2
+       * @default false
+       * @supported weapp
+       */
+      enableHttp2?: boolean
+      /** 开启 quic
+       * @default false
+       * @supported weapp
+       */
+      enableQuic?: boolean
+      /** 开启 cache
+       * @default false
+       * @supported weapp, tt
+       */
+      enableCache?: boolean
+      /** 是否开启 HttpDNS 服务。如开启，需要同时填入 httpDNSServiceId 。 HttpDNS 用法详见 移动解析HttpDNS
+       * @default false
+       * @supported weapp
+       */
+      enableHttpDNS?: boolean
+      /** HttpDNS 服务商 Id。 HttpDNS 用法详见 移动解析HttpDNS
+       * @supported weapp
+       */
+      httpDNSServiceId?: string
+      /** 开启 transfer-encoding chunked。
+       * @default false
+       * @supported weapp
+       */
+      enableChunked?: boolean
       /** 接口调用成功的回调函数 */
-      success?: (result: SuccessCallbackResult) => void
+      success?: (result: SuccessCallbackResult<T>) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 设置 H5 端是否使用jsonp方式获取数据
        * @default false
+       * @supported h5
        */
       jsonp?: boolean
       /** 设置 H5 端 jsonp 请求 url 是否需要被缓存
        * @default false
+       * @supported h5
        */
       jsonpCache?: boolean
       /** 设置 H5 端是否允许跨域请求
        * @default same-origin
+       * @supported h5
        */
-      mode?: keyof cors_mode
+      mode?: keyof CorsMode
       /** 设置 H5 端是否携带 Cookie
        * @default omit
+       * @supported h5
        */
-      credentials?: keyof credentials
+      credentials?: keyof Credentials
       /** 设置 H5 端缓存模式
        * @default default
+       * @supported h5
        */
-      cache?: keyof cache
-      /** 设置 H5 端请求响应超时时间
-       * @default 2000
-       */
-      timeout?: number
+      cache?: keyof Cache
       /** 设置 H5 端请求重试次数
        * @default 2
+       * @supported h5
        */
       retryTimes?: number
-      /** 设置 H5 端请求的兜底接口 */
+      /** 设置 H5 端请求的兜底接口
+       * @supported h5
+       */
       backup?: string | string[]
-      /** 设置 H5 端请求响应的数据校验函数，若返回 false，则请求兜底接口，若无兜底接口，则报请求失败 */
+      /** 设置 H5 端请求响应的数据校验函数，若返回 false，则请求兜底接口，若无兜底接口，则报请求失败
+       * @supported h5
+       */
       dataCheck?(): boolean
       /** 设置 H5 端请求是否使用缓存
        * @default false
+       * @supported h5
        */
       useStore?: boolean
-      /** 设置 H5 端请求缓存校验的 key */
+      /** 设置 H5 端请求缓存校验的 key
+       * @supported h5
+       */
       storeCheckKey?: string
-      /** 设置 H5 端请求缓存签名 */
+      /** 设置 H5 端请求缓存签名
+       * @supported h5
+       */
       storeSign?: string
-      /** 设置 H5 端请求校验函数，一般不需要设置 */
+      /** 设置 H5 端请求校验函数，一般不需要设置
+       * @supported h5
+       */
       storeCheck?(): boolean
     }
 
@@ -81,7 +131,7 @@ declare module '../../index' {
     }
 
     /** 返回的数据格式 */
-    interface dataType {
+    interface DataType {
       /** 返回的数据为 JSON，返回后会对返回的数据进行一次 JSON.parse
        * 其他: 不对返回的内容进行 JSON.parse
        */
@@ -89,7 +139,7 @@ declare module '../../index' {
     }
 
     /** HTTP 请求方法 */
-    interface method {
+    interface Method {
       /** HTTP 请求 OPTIONS */
       OPTIONS
       /** HTTP 请求 GET */
@@ -109,7 +159,7 @@ declare module '../../index' {
     }
 
     /** 响应的数据类型 */
-    interface responseType {
+    interface ResponseType {
       /** 响应的数据为文本 */
       text
       /** 响应的数据为 ArrayBuffer */
@@ -117,7 +167,7 @@ declare module '../../index' {
     }
 
     /** 跨域策略 */
-    interface cors_mode {
+    interface CorsMode {
       /** 跨域请求将获取不透明的响应 */
       'no-cors'
       /** 允许跨域请求 */
@@ -126,7 +176,7 @@ declare module '../../index' {
       'same-origin'
     }
     /** 证书 */
-    interface credentials {
+    interface Credentials {
       /** 不论是不是跨域的请求,总是发送请求资源域在本地的 cookies、 HTTP Basic authentication 等验证信息 */
       include
       /** 只有当URL与响应脚本同源才发送 cookies、 HTTP Basic authentication 等验证信息 */
@@ -135,7 +185,7 @@ declare module '../../index' {
       omit
     }
     /** 缓存策略 */
-    interface cache {
+    interface Cache {
       /** 浏览器从HTTP缓存中寻找匹配的请求 */
       default
       /** 浏览器在其HTTP缓存中寻找匹配的请求 */
@@ -150,6 +200,7 @@ declare module '../../index' {
   }
 
   /** 网络请求任务对象
+   * @supported weapp, h5, rn, alipay, swan, tt, qq
    * @example
    * 回调函数(Callback)用法：
    *
@@ -199,40 +250,76 @@ declare module '../../index' {
    * const res = await requestTask
    * requestTask.abort()
    * ```
+   * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/request/RequestTask.html
    */
   interface RequestTask<T> extends Promise<request.SuccessCallbackResult<T>> {
     /** 中断请求任务
-     * @supported weapp
+     * @supported weapp, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/request/RequestTask.abort.html
      */
     abort(): void
+    /** 监听 HTTP Response Header 事件。会比请求完成事件更早
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/request/RequestTask.onHeadersReceived.html
+     */
+    onHeadersReceived(
+      /** HTTP Response Header 事件的回调函数 */
+      callback: RequestTask.onHeadersReceived.Callback,
+    ): void
     /** 取消监听 HTTP Response Header 事件
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/request/RequestTask.offHeadersReceived.html
      */
     offHeadersReceived(
       /** HTTP Response Header 事件的回调函数 */
-      callback: (res: TaroGeneral.CallbackResult) => void,
+      callback: RequestTask.onHeadersReceived.Callback,
     ): void
-    /** 监听 HTTP Response Header 事件。会比请求完成事件更早
+    /** 监听 Transfer-Encoding Chunk Received 事件。当接收到新的chunk时触发。
      * @supported weapp
-     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/request/RequestTask.onHeadersReceived.html
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/request/RequestTask.onChunkReceived.html
      */
-    onHeadersReceived(
-      /** HTTP Response Header 事件的回调函数 */
-      callback: (result: RequestTask.OnHeadersReceivedCallbackResult) => void,
+    onChunkReceived(
+      /** Transfer-Encoding Chunk Received 事件的回调函数 */
+      callback: RequestTask.onChunkReceived.Callback,
+    ): void
+    /** 监听 Transfer-Encoding Chunk Received 事件。当接收到新的chunk时触发。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/request/RequestTask.offChunkReceived.html
+     */
+    offChunkReceived(
+      /** Transfer-Encoding Chunk Received 事件的回调函数 */
+      callback: RequestTask.onChunkReceived.Callback,
     ): void
   }
 
   namespace RequestTask {
-    interface OnHeadersReceivedCallbackResult {
-      /** 开发者服务器返回的 HTTP Response Header */
-      header: TaroGeneral.IAnyObject
+    namespace onHeadersReceived {
+      /** HTTP Response Header 事件的回调函数 */
+      type Callback = (result: CallbackResult) => void
+      interface CallbackResult {
+        /** 开发者服务器返回的 HTTP Response Header */
+        header: TaroGeneral.IAnyObject
+      }
+    }
+    namespace onChunkReceived {
+      /** Transfer-Encoding Chunk Received 事件的回调函数 */
+      type Callback = (result: CallbackResult) => void
+      interface CallbackResult {
+        /** 开发者服务器每次返回新 chunk 时的 Response */
+        res: Response
+      }
+      /** 开发者服务器每次返回新 chunk 时的 Response */
+      interface Response {
+        /** 返回的chunk buffer */
+        data: ArrayBuffer
+      }
     }
   }
 
+  /** @ignore */
   type interceptor = (chain: Chain) => any
 
+  /** @ignore */
   interface Chain {
     index: number
     requestParams: RequestParams
@@ -240,6 +327,7 @@ declare module '../../index' {
     proceed(requestParams: RequestParams): any
   }
 
+  /** @ignore */
   interface interceptors {
     logInterceptor(chain: Chain): Promise<any>
 
@@ -279,7 +367,7 @@ declare module '../../index' {
      * ```
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/request/wx.request.html
      */
-    request<T = any, U = any>(option: request.Option<U>): RequestTask<T>
+    request<T = any, U = any>(option: request.Option<T, U>): RequestTask<T>
 
     /** 可以使用拦截器在请求发出前或发出后做一些额外操作。
      *

package/types/api/network/tcp.d.ts

@@ -0,0 +1,181 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  /** 一个 TCP Socket 实例，默认使用 IPv4 协议
+   * @supported weapp
+   * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.html
+   */
+  interface TCPSocket {
+    /** 在给定的套接字上启动连接
+     * @supported weapp
+     * @example
+     * ```tsx
+     * const tcp = Taro.createTCPSocket()
+     * tcp.connect({ address: '192.168.193.2', port: 8848 })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.connect.html
+     */
+    connect(option: TCPSocket.connect.Option): void
+    /** 在 socket 上发送数据
+     * @supported weapp
+     * @example
+     * ```tsx
+     * const tcp = Taro.createTCPSocket()
+     * tcp.write('hello, how are you')
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.write.html
+     */
+    write(
+      /** 要发送的数据 */
+      data: string | ArrayBuffer
+    ): void
+    /** 关闭连接
+     * @supported weapp
+     * @example
+     * ```tsx
+     * const tcp = Taro.createTCPSocket()
+     * tcp.close()
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.close.html
+     */
+    close(): void
+    /** 监听关闭事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.onClose.html
+     */
+    onClose(
+      /** 当一个 socket 完全关闭就发出该事件的回调函数 */
+      callback: TCPSocket.onClose.Callback,
+    ): void
+    /** 取消监听当一个 socket 完全关闭就发出该事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.offClose.html
+     */
+    offClose(
+      /** 当一个 socket 完全关闭就发出该事件的回调函数 */
+      callback: TCPSocket.onClose.Callback,
+    ): void
+    /** 监听当一个 socket 连接成功建立的时候触发该事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.onConnect.html
+     */
+    onConnect(
+      /** 当一个 socket 连接成功建立的时候触发该事件的回调函数 */
+      callback: TCPSocket.onConnect.Callback,
+    ): void
+    /** 取消监听当一个 socket 连接成功建立的时候触发该事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.offConnect.html
+     */
+    offConnect(
+      /** 当一个 socket 连接成功建立的时候触发该事件的回调函数 */
+      callback: TCPSocket.onConnect.Callback,
+    ): void
+    /** 监听当错误发生时触发
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.onError.html
+     */
+    onError(
+      /** 监听当错误发生时触发的回调函数 */
+      callback: TCPSocket.onError.Callback,
+    ): void
+    /** 取消监听当错误发生时触发
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.offError.html
+     */
+    offError(
+      /** 监听当错误发生时触发的回调函数 */
+      callback: TCPSocket.onError.Callback,
+    ): void
+    /** 监听当接收到数据的时触发该事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.onMessage.html
+     */
+    onMessage(
+      /** 当接收到数据的时触发该事件的回调函数 */
+      callback: TCPSocket.onMessage.Callback,
+    ): void
+    /** 取消监听当接收到数据的时触发该事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/TCPSocket.offMessage.html
+     */
+    offMessage(
+      /** 当接收到数据的时触发该事件的回调函数 */
+      callback: TCPSocket.onMessage.Callback,
+    ): void
+  }
+
+  namespace TCPSocket {
+    namespace connect {
+      interface Option {
+        /** 套接字要连接的地址 */
+        address: string
+        /** 套接字要连接的端口 */
+        port: number
+      }
+    }
+    namespace onClose {
+      /** 当一个 socket 完全关闭就发出该事件的回调函数 */
+      type Callback = (...args: unknown[]) => void
+    }
+    namespace onConnect {
+      /** 当一个 socket 连接成功建立的时候触发该事件的回调函数 */
+      type Callback = (...args: unknown[]) => void
+    }
+    namespace onError {
+      /** 监听当错误发生时触发的回调函数 */
+      type Callback = (result: CallbackResult) => void
+      interface CallbackResult extends TaroGeneral.CallbackResult {
+        /** 错误信息 */
+        errMsg: string
+      }
+    }
+    namespace onMessage {
+      /** 当接收到数据的时触发该事件的回调函数 */
+      type Callback = (result: CallbackResult) => void
+      interface CallbackResult extends TaroGeneral.CallbackResult {
+        /** 收到的消息 */
+        message: ArrayBuffer
+        /** 发送端地址信息 */
+        remoteInfo: RemoteInfo
+        /** 接收端地址信息 */
+        localInfo: LocalInfo
+      }
+      /** 发送端地址信息 */
+      interface RemoteInfo {
+        /** 发送消息的 socket 的地址 */
+        address: string
+        /** 使用的协议族，为 IPv4 或者 IPv6 */
+        family: string
+        /** 端口号 */
+        port: number
+        /** message 的大小，单位：字节 */
+        size: number
+      }
+      /** 接收端地址信息 */
+      interface LocalInfo {
+        /** 接收消息的 socket 的地址 */
+        address: string
+        /** 使用的协议族，为 IPv4 或者 IPv6 */
+        family: string
+        /** 端口号 */
+        port: number
+      }
+    }
+  }
+
+  interface TaroStatic {
+    /** 创建一个 TCP Socket 实例。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/network.html)。
+     *
+     * **连接限制**
+     *
+     * - 允许与局域网内的非本机 IP 通信
+     * - 允许与配置过的服务器域名通信，详见[相关说明](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/network.html)
+     * - 禁止与以下端口号连接：1024 以下 1099 1433 1521 1719 1720 1723 2049 2375 3128 3306 3389 3659 4045 5060 5061 5432 5984 6379 6000 6566 7001 7002 8000-8100 8443 8888 9200 9300 10051 10080 11211 27017 27018 27019
+     * - 每 5 分钟内最多创建 20 个 TCPSocket
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/tcp/wx.createTCPSocket.html
+     */
+    createTCPSocket(): TCPSocket
+  }
+}