@spcsn/taro 0.1.0

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

@@ -0,0 +1,218 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  /** 一个 UDP Socket 实例，默认使用 IPv4 协议。
+   * @supported weapp
+   * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.html
+   */
+  interface UDPSocket {
+    /** 绑定一个系统随机分配的可用端口，或绑定一个指定的端口号
+     * @supported weapp
+     * @example
+     * ```tsx
+     * const udp = Taro.createUDPSocket()
+     * udp.close()
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.bind.html
+     */
+    bind(
+      /** 指定要绑定的端口号，不传则返回系统随机分配的可用端口 */
+      port: number,
+    ): number
+    /** 设置 IP_TTL 套接字选项，用于设置一个 IP 数据包传输时允许的最大跳步数
+     * @supported weapp
+     * @example
+     * ```tsx
+     * const udp = Taro.createUDPSocket()
+     * udp.onListening(function () {
+     *   udp.setTTL(64)
+     * })
+     * udp.bind()
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.setTTL.html
+     */
+    setTTL(
+      /** ttl 参数可以是 0 到 255 之间 */
+      ttl: number
+    ): void
+    /** 向指定的 IP 和 port 发送消息
+     * @supported weapp
+     * @example
+     * ```tsx
+     * const udp = Taro.createUDPSocket()
+     * udp.bind()
+     * udp.send({
+     *   address: '192.168.193.2',
+     *   port: 8848,
+     *   message: 'hello, how are you'
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.send.html
+     */
+    send(option: UDPSocket.send.Option): void
+    /** 预先连接到指定的 IP 和 port，需要配合 write 方法一起使用
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.connect.html
+     */
+    connect(option: UDPSocket.connect.Option): void
+    /** 用法与 send 方法相同，如果没有预先调用 connect 则与 send 无差异（注意即使调用了 connect 也需要在本接口填入地址和端口参数）
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.write.html
+     */
+    write(): void
+    /** 关闭 UDP Socket 实例，相当于销毁。 在关闭之后，UDP Socket 实例不能再发送消息，每次调用 `UDPSocket.send` 将会触发错误事件，并且 message 事件回调函数也不会再也执行。在 `UDPSocket` 实例被创建后将被 Native 强引用，保证其不被 GC。在 `UDPSocket.close` 后将解除对其的强引用，让 UDPSocket 实例遵从 GC。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.close.html
+     */
+    close(): void
+    /** 监听关闭事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.onClose.html
+     */
+    onClose(
+      /** 关闭事件的回调函数 */
+      callback: UDPSocket.onClose.Callback,
+    ): void
+    /** 取消监听关闭事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.offClose.html
+     */
+    offClose(
+      /** 关闭事件的回调函数 */
+      callback: UDPSocket.onClose.Callback,
+    ): void
+    /** 监听错误事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.onError.html
+     */
+    onError(
+      /** 错误事件的回调函数 */
+      callback: UDPSocket.onError.Callback,
+    ): void
+    /** 取消监听错误事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.offError.html
+     */
+    offError(
+      /** 错误事件的回调函数 */
+      callback: UDPSocket.onError.Callback,
+    ): void
+    /** 监听开始监听数据包消息的事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.onListening.html
+     */
+    onListening(
+      /** 监听开始监听数据包消息的事件 */
+      callback: UDPSocket.onListening.Callback,
+    ): void
+    /** 取消监听开始监听数据包消息的事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.offListening.html
+     */
+    offListening(
+      /** 监听开始监听数据包消息的事件 */
+      callback: UDPSocket.onListening.Callback,
+    ): void
+    /** 监听收到消息的事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.onMessage.html
+     */
+    onMessage(
+      /** 收到消息的事件的回调函数 */
+      callback: UDPSocket.onMessage.Callback,
+    ): void
+    /** 取消监听收到消息的事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/UDPSocket.offMessage.html
+     */
+    offMessage(
+      /** 收到消息的事件的回调函数 */
+      callback: UDPSocket.onMessage.Callback,
+    ): void
+  }
+
+  namespace UDPSocket {
+    namespace connect {
+      interface Option {
+        /** 要发消息的地址 */
+        address: string
+        /** 要发送消息的端口号 */
+        port: number
+      }
+    }
+    namespace onClose {
+      /** 当一个 socket 完全关闭就发出该事件的回调函数 */
+      type Callback = (...args: unknown[]) => void
+    }
+    namespace onError {
+      /** 错误事件的回调函数 */
+      type Callback = (result: CallbackResult) => void
+      interface CallbackResult extends TaroGeneral.CallbackResult {
+        /** 错误信息 */
+        errMsg: string
+      }
+    }
+    namespace onListening {
+      /** 监听开始监听数据包消息的事件 */
+      type Callback = (...args: unknown[]) => void
+    }
+    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
+      }
+      /** 接收端地址信息 */
+      interface LocalInfo {
+        /** 接收消息的 socket 的地址 */
+        address: string
+        /** 使用的协议族，为 IPv4 或者 IPv6 */
+        family: string
+        /** 端口号 */
+        port: number
+        /** message 的大小，单位：字节 */
+        size: number
+      }
+    }
+    namespace send {
+      interface Option {
+        /** 要发消息的地址。在基础库 <= 2.9.3 版本必须是和本机同网段的 IP 地址，或安全域名列表内的域名地址；之后版本可以是任意 IP 和域名 */
+        address: string
+        /** 要发送消息的端口号 */
+        port: number
+        /** 要发送的数据 */
+        message: string | ArrayBuffer
+        /** 发送数据的偏移量，仅当 message 为 ArrayBuffer 类型时有效
+         * @default 0
+         */
+        offset?: number
+        /** 发送数据的长度，仅当 message 为 ArrayBuffer 类型时有效
+         * @default message.byteLength
+         */
+        length?: number
+      }
+    }
+  }
+
+  interface TaroStatic {
+    /** 创建一个 UDP Socket 实例。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/network.html)。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/udp/wx.createUDPSocket.html
+     */
+    createUDPSocket(): UDPSocket
+  }
+}

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

@@ -0,0 +1,201 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace uploadFile {
+    interface Option {
+      /** 开发者服务器地址 */
+      url: string
+      /** 要上传文件资源的路径 */
+      filePath: string
+      /** 文件对应的 key，开发者在服务端可以通过这个 key 获取文件的二进制内容 */
+      name: string
+      /** HTTP 请求 Header，Header 中不能设置 Referer */
+      header?: TaroGeneral.IAnyObject
+      /** HTTP 请求中其他额外的 form data */
+      formData?: TaroGeneral.IAnyObject
+      /** 超时时间，单位为毫秒 */
+      timeout?: number
+      /** 上传的文件名
+       * @supported h5
+       */
+      fileName?: string
+      /** 是否应使用传出凭据 (cookie) 发送此请求
+       * @default true
+       * @supported h5
+       */
+      withCredentials?: boolean
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (
+        result: SuccessCallbackResult,
+      ) => void
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 开发者服务器返回的数据 */
+      data: string
+      /** 开发者服务器返回的 HTTP 状态码 */
+      statusCode: number
+      /** 调用结果 */
+      errMsg: string
+      /**
+       * 开发者服务器返回的 HTTP Response Header
+       * @supported weapp
+       * @weapp 非官方文档标注属性
+       */
+      header?: TaroGeneral.IAnyObject
+      /**
+       * cookies
+       * @supported weapp
+       * @weapp 非官方文档标注属性
+       */
+      cookies?: string[]
+    }
+  }
+
+  namespace UploadTask {
+    /** HTTP Response Header 事件的回调函数 */
+    type OnHeadersReceivedCallback = (
+      result: OnHeadersReceivedCallbackResult,
+    ) => void
+    /** 上传进度变化事件的回调函数 */
+    type OnProgressUpdateCallback = (
+      result: OnProgressUpdateCallbackResult,
+    ) => void
+    interface OnHeadersReceivedCallbackResult {
+      /** 开发者服务器返回的 HTTP Response Header */
+      header: TaroGeneral.IAnyObject
+    }
+    interface OnProgressUpdateCallbackResult {
+      /** 上传进度百分比 */
+      progress: number
+      /** 预期需要上传的数据总长度，单位 Bytes */
+      totalBytesExpectedToSend: number
+      /** 已经上传的数据长度，单位 Bytes */
+      totalBytesSent: number
+    }
+
+    type UploadTaskPromise = Promise<uploadFile.SuccessCallbackResult> & UploadTask & {
+      headersReceive: UploadTask['onHeadersReceived']
+      progress: UploadTask['onProgressUpdate']
+    }
+  }
+
+  /** 一个可以监听上传进度变化事件，以及取消上传任务的对象
+   * @supported weapp, swan, alipay, h5, rn, tt, harmony_hybrid
+   * @example
+   * ```tsx
+   * const uploadTask = Taro.uploadFile({
+   *   url: 'http://example.weixin.qq.com/upload', //仅为示例，非真实的接口地址
+   *   filePath: tempFilePaths[0],
+   *   name: 'file',
+   *   formData:{
+   *     'user': 'test'
+   *   },
+   *   success (res){
+   *     const data = res.data
+   *     //do something
+   *   }
+   * })
+   *
+   * uploadTask.onProgressUpdate((res) => {
+   *   console.log('上传进度', res.progress)
+   *   console.log('已经上传的数据长度', res.totalBytesSent)
+   *   console.log('预期需要上传的数据总长度', res.totalBytesExpectedToSend)
+   * })
+   *
+   * uploadTask.abort() // 取消上传任务
+   * ```
+   * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/upload/UploadTask.html
+   */
+  interface UploadTask {
+    /** 中断上传任务
+     * @supported weapp, h5, tt, harmony_hybrid
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/upload/UploadTask.abort.html
+     */
+    abort(): void
+    /** 监听上传进度变化事件
+     * @supported weapp, h5, tt, harmony_hybrid
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/upload/UploadTask.onProgressUpdate.html
+     */
+    onProgressUpdate(
+      /** 上传进度变化事件的回调函数 */
+      callback: UploadTask.OnProgressUpdateCallback,
+    ): void
+    /** 取消监听上传进度变化事件
+     * @supported weapp, h5, tt, harmony_hybrid
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/upload/UploadTask.offProgressUpdate.html
+     */
+    offProgressUpdate(
+      /** 上传进度变化事件的回调函数 */
+      callback: UploadTask.OnProgressUpdateCallback,
+    ): void
+    /** 监听 HTTP Response Header 事件。会比请求完成事件更早
+     * @supported weapp, h5, harmony_hybrid
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/upload/UploadTask.onHeadersReceived.html
+     */
+    onHeadersReceived(
+      /** HTTP Response Header 事件的回调函数 */
+      callback: UploadTask.OnHeadersReceivedCallback,
+    ): void
+    /** 取消监听 HTTP Response Header 事件
+     * @supported weapp, h5, harmony_hybrid
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/upload/UploadTask.offHeadersReceived.html
+     */
+    offHeadersReceived(
+      /** HTTP Response Header 事件的回调函数 */
+      callback: UploadTask.OnHeadersReceivedCallback,
+    ): void
+  }
+
+  interface TaroStatic {
+    /** 将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求，其中 `content-type` 为 `multipart/form-data`。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/network.html)。
+     * @supported weapp, swan, alipay, h5, rn, tt, harmony_hybrid, harmony
+     * @example
+     * ```tsx
+     * Taro.chooseImage({
+     *   success (res) {
+     *     const tempFilePaths = res.tempFilePaths
+     *     Taro.uploadFile({
+     *       url: 'https://example.weixin.qq.com/upload', //仅为示例，非真实的接口地址
+     *       filePath: tempFilePaths[0],
+     *       name: 'file',
+     *       formData: {
+     *         'user': 'test'
+     *       },
+     *       success (res){
+     *         const data = res.data
+     *         //do something
+     *       }
+     *     })
+     *   }
+     * })
+     * ```
+     * @example
+     * ```tsx
+     * const uploadTask = Taro.uploadFile({
+     *   url: 'https://example.weixin.qq.com/upload', //仅为示例，非真实的接口地址
+     *   filePath: tempFilePaths[0],
+     *   name: 'file',
+     *   formData:{
+     *     'user': 'test'
+     *   },
+     *   success: function (res){
+     *     var data = res.data
+     *     //do something
+     *   }
+     * })
+     * uploadTask.progress((res) => {
+     *   console.log('上传进度', res.progress)
+     *   console.log('已经上传的数据长度', res.totalBytesSent)
+     *   console.log('预期需要上传的数据总长度', res.totalBytesExpectedToSend)
+     * })
+     * uploadTask.abort() // 取消上传任务
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/upload/wx.uploadFile.html
+     */
+    uploadFile(option: uploadFile.Option): UploadTask.UploadTaskPromise
+  }
+}