@tarojs/taro 3.4.1 → 3.4.2

package/types/api/device/contact.d.ts

@@ -1,82 +1,106 @@
 import Taro from '../../index'
 
 declare module '../../index' {
+  namespace chooseContact {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 手机号 */
+      phoneNumber: string
+      /** 联系人姓名 */
+      displayName: string
+      /** 选定联系人的所有手机号（部分 Android 系统只能选联系人而不能选特定手机号） */
+      phoneNumberList: string
+    }
+  }
+
   namespace addPhoneContact {
     interface Option {
       /** 名字 */
       firstName: string
-      /** 联系地址城市 */
-      addressCity?: string
+      /** 头像本地文件路径 */
+      photoFilePath?: string
+      /** 昵称 */
+      nickName?: string
+      /** 中间名 */
+      middleName?: string
+      /** 姓氏 */
+      lastName?: string
+      /** 备注 */
+      remark?: string
+      /** 手机号 */
+      mobilePhoneNumber?: string
+      /** 微信号 */
+      weChatNumber?: string
       /** 联系地址国家 */
       addressCountry?: string
-      /** 联系地址邮政编码 */
-      addressPostalCode?: string
       /** 联系地址省份 */
       addressState?: string
+      /** 联系地址城市 */
+      addressCity?: string
       /** 联系地址街道 */
       addressStreet?: string
-      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: TaroGeneral.CallbackResult) => void
-      /** 电子邮件 */
-      email?: string
-      /** 接口调用失败的回调函数 */
-      fail?: (res: TaroGeneral.CallbackResult) => void
-      /** 住宅地址城市 */
-      homeAddressCity?: string
-      /** 住宅地址国家 */
-      homeAddressCountry?: string
-      /** 住宅地址邮政编码 */
-      homeAddressPostalCode?: string
-      /** 住宅地址省份 */
-      homeAddressState?: string
-      /** 住宅地址街道 */
-      homeAddressStreet?: string
-      /** 住宅传真 */
-      homeFaxNumber?: string
-      /** 住宅电话 */
-      homePhoneNumber?: string
-      /** 公司电话 */
-      hostNumber?: string
-      /** 姓氏 */
-      lastName?: string
-      /** 中间名 */
-      middleName?: string
-      /** 手机号 */
-      mobilePhoneNumber?: string
-      /** 昵称 */
-      nickName?: string
+      /** 联系地址邮政编码 */
+      addressPostalCode?: string
       /** 公司 */
       organization?: string
-      /** 头像本地文件路径 */
-      photoFilePath?: string
-      /** 备注 */
-      remark?: string
-      /** 接口调用成功的回调函数 */
-      success?: (res: TaroGeneral.CallbackResult) => void
       /** 职位 */
       title?: string
+      /** 工作传真 */
+      workFaxNumber?: string
+      /** 工作电话 */
+      workPhoneNumber?: string
+      /** 公司电话 */
+      hostNumber?: string
+      /** 电子邮件 */
+      email?: string
       /** 网站 */
       url?: string
-      /** 微信号 */
-      weChatNumber?: string
-      /** 工作地址城市 */
-      workAddressCity?: string
       /** 工作地址国家 */
       workAddressCountry?: string
-      /** 工作地址邮政编码 */
-      workAddressPostalCode?: string
       /** 工作地址省份 */
       workAddressState?: string
+      /** 工作地址城市 */
+      workAddressCity?: string
       /** 工作地址街道 */
       workAddressStreet?: string
-      /** 工作传真 */
-      workFaxNumber?: string
-      /** 工作电话 */
-      workPhoneNumber?: string
+      /** 工作地址邮政编码 */
+      workAddressPostalCode?: string
+      /** 住宅传真 */
+      homeFaxNumber?: string
+      /** 住宅电话 */
+      homePhoneNumber?: string
+      /** 住宅地址国家 */
+      homeAddressCountry?: string
+      /** 住宅地址省份 */
+      homeAddressState?: string
+      /** 住宅地址城市 */
+      homeAddressCity?: string
+      /** 住宅地址街道 */
+      homeAddressStreet?: string
+      /** 住宅地址邮政编码 */
+      homeAddressPostalCode?: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
     }
   }
 
   interface TaroStatic {
+    /** 添加手机通讯录联系人。用户可以选择将该表单以「新增联系人」或「添加到已有联系人」的方式，写入手机系统通讯录。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/contact/wx.chooseContact.html
+     */
+    chooseContact(option: chooseContact.Option): Promise<TaroGeneral.CallbackResult>
     /** 添加手机通讯录联系人。用户可以选择将该表单以「新增联系人」或「添加到已有联系人」的方式，写入手机系统通讯录。
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/contact/wx.addPhoneContact.html

package/types/api/device/gyroscope.d.ts

@@ -20,13 +20,13 @@ declare module '../../index' {
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
       /** 监听陀螺仪数据回调函数的执行频率 */
-      interval?: keyof interval
+      interval?: keyof Interval
       /** 接口调用成功的回调函数 */
       success?: (res: TaroGeneral.CallbackResult) => void
     }
 
     /** 监听陀螺仪数据回调函数的执行频率 */
-    interface interval {
+    interface Interval {
       /** 适用于更新游戏的回调频率，在 20ms/次 左右 */
       game
       /** 适用于更新 UI 的回调频率，在 60ms/次 左右 */
@@ -53,19 +53,19 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 停止监听陀螺仪数据。
-     * @supported weapp
+     * @supported weapp, rn
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/gyroscope/wx.stopGyroscope.html
      */
     stopGyroscope(option?: stopGyroscope.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 开始监听陀螺仪数据。
-     * @supported weapp
+     * @supported weapp, rn
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/gyroscope/wx.startGyroscope.html
      */
     startGyroscope(option: startGyroscope.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 监听陀螺仪数据变化事件。频率根据 Taro.startGyroscope() 的 interval 参数。可以使用 Taro.stopGyroscope() 停止监听。
-     * @supported weapp
+     * @supported weapp, rn
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/gyroscope/wx.onGyroscopeChange.html
      */
     onGyroscopeChange(

package/types/api/device/iBeacon.d.ts

@@ -70,18 +70,32 @@ declare module '../../index' {
   }
 
   interface IBeaconInfo {
-    /** iBeacon 设备的距离 */
-    accuracy: number
-    /** iBeacon 设备的主 id */
+    /** Beacon 设备广播的 uuid */
+    uuid: string
+    /** Beacon 设备的主 ID */
     major: string
-    /** iBeacon 设备的次 id */
+    /** Beacon 设备的次 ID */
     minor: string
-    /** 表示设备距离的枚举值 */
-    proximity: number
-    /** 表示设备的信号强度 */
+    /** 表示设备距离的枚举值（仅iOS） */
+    proximity: keyof IBeaconInfo.Proximity
+    /** Beacon 设备的距离，单位 m。iOS 上，proximity 为 0 时，accuracy 为 -1。 */
+    accuracy: number
+    /** 表示设备的信号强度，单位 dBm */
     rssi: number
-    /** iBeacon 设备广播的 uuid */
-    uuid: string
+  }
+
+  namespace IBeaconInfo {
+    /** proximity 的合法值 */
+    interface Proximity {
+      /** 信号太弱不足以计算距离，或非 iOS 设备 */
+      0
+      /** 十分近 */
+      1
+      /** 比较近 */
+      2
+      /** 远 */
+      3
+    }
   }
 
   interface TaroStatic {
@@ -93,7 +107,7 @@ declare module '../../index' {
      * ```
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.stopBeaconDiscovery.html
      */
-    stopBeaconDiscovery(option?: stopBeaconDiscovery.Option): Promise<TaroGeneral.CallbackResult>
+    stopBeaconDiscovery(option?: stopBeaconDiscovery.Option): Promise<TaroGeneral.IBeaconError>
 
     /** 开始搜索附近的 iBeacon 设备
      * @supported weapp
@@ -105,7 +119,7 @@ declare module '../../index' {
      * ```
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.startBeaconDiscovery.html
      */
-    startBeaconDiscovery(option: startBeaconDiscovery.Option): Promise<TaroGeneral.CallbackResult>
+    startBeaconDiscovery(option: startBeaconDiscovery.Option): Promise<TaroGeneral.IBeaconError>
 
     /** 监听 iBeacon 设备更新事件，仅能注册一个监听
      * @supported weapp
@@ -125,19 +139,13 @@ declare module '../../index' {
       callback: onBeaconServiceChange.Callback,
     ): void
 
-    /** 获取所有已搜索到的 iBeacon 设备
-     * @supported weapp
-     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.getBeacons.html
-     */
-    getBeacons(option?: getBeacons.Option): Promise<getBeacons.CallbackResult>
-
     /** 取消监听 iBeacon 设备更新事件
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.offBeaconUpdate.html
      */
     offBeaconUpdate(
       /** iBeacon 设备更新事件的回调函数 */
-      callback: (res: TaroGeneral.CallbackResult) => void,
+      callback: (res: TaroGeneral.IBeaconError) => void,
     ): void
 
     /** 取消监听 iBeacon 服务状态变化事件
@@ -146,7 +154,13 @@ declare module '../../index' {
      */
     offBeaconServiceChange(
       /** iBeacon 服务状态变化事件的回调函数 */
-      callback: (res: TaroGeneral.CallbackResult) => void,
+      callback: (res: TaroGeneral.IBeaconError) => void,
     ): void
+
+    /** 获取所有已搜索到的 iBeacon 设备
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.getBeacons.html
+     */
+    getBeacons(option?: getBeacons.Option): Promise<getBeacons.CallbackResult>
   }
 }

package/types/api/device/{performance.d.ts → memory.d.ts}

@@ -9,10 +9,10 @@ declare module '../../index' {
 
     interface CallbackResult {
       /** 内存告警等级，只有 Android 才有，对应系统宏定义 */
-      level: keyof level
+      level: keyof Level
     }
 
-    interface level {
+    interface Level {
       /** TRIM_MEMORY_RUNNING_MODERATE */
       5
       /** TRIM_MEMORY_RUNNING_LOW */
@@ -46,8 +46,8 @@ declare module '../../index' {
      */
     offMemoryWarning(
       /** 取消监听内存不足告警事件 */
-      callback: (...args: any[]) => any,
+      callback: onMemoryWarning.Callback,
     ): void
-    
+
   }
 }

package/types/api/device/motion.d.ts

@@ -10,11 +10,11 @@ declare module '../../index' {
       /** 监听设备方向的变化回调函数的执行频率
        * @default "normal"
        */
-      interval?: keyof interval
+      interval?: keyof Interval
       /** 接口调用成功的回调函数 */
       success?: (res: TaroGeneral.CallbackResult) => void
     }
-    interface interval {
+    interface Interval {
       /** 适用于更新游戏的回调频率，在 20ms/次 左右 */
       game
       /** 适用于更新 UI 的回调频率，在 60ms/次 左右 */
@@ -75,7 +75,7 @@ declare module '../../index' {
     onDeviceMotionChange (callback: onDeviceMotionChange.Callback): void
 
     /** 取消监听设备方向变化事件，参数为空，则取消所有的事件监听。
-     * @supported weapp, rn
+     * @supported weapp, h5, rn
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/motion/wx.offDeviceMotionChange.html
      */
     offDeviceMotionChange(

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

@@ -1,6 +1,20 @@
 import Taro from '../../index'
 
 declare module '../../index' {
+  namespace onNetworkWeakChange {
+    /** 弱网状态变化事件的回调函数 */
+    type Callback = (
+        result: CallbackResult,
+    ) => void
+
+    interface CallbackResult {
+      /** 当前是否处于弱网状态 */
+      weakNet: boolean
+      /** 当前网络类型 */
+      networkType: keyof getNetworkType.NetworkType
+    }
+  }
+
   namespace onNetworkStatusChange {
     /** 网络状态变化事件的回调函数 */
     type Callback = (
@@ -11,7 +25,7 @@ declare module '../../index' {
       /** 当前是否有网络连接 */
       isConnected: boolean
       /** 网络类型 */
-      networkType: keyof getNetworkType.networkType
+      networkType: keyof getNetworkType.NetworkType
     }
   }
 
@@ -26,13 +40,13 @@ declare module '../../index' {
     }
     interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 网络类型 */
-      networkType: keyof networkType
+      networkType: keyof NetworkType
       /** 调用结果 */
       errMsg: string
     }
 
     /** 网络类型 */
-    interface networkType {
+    interface NetworkType {
       /** wifi 网络 */
       wifi
       /** 2g 网络 */
@@ -68,6 +82,24 @@ declare module '../../index' {
   }
 
   interface TaroStatic {
+    /** 监听弱网状态变化事件
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.onNetworkWeakChange(function (res) {
+     *   console.log(res.weakNet)
+     *   console.log(res.networkType)
+     * })
+     * // 取消监听
+     * Taro.offNetworkWeakChange()
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/network/wx.onNetworkWeakChange.html
+     */
+    onNetworkWeakChange(
+      /** 弱网状态变化事件的回调函数 */
+      callback: onNetworkWeakChange.Callback,
+    ): void
+
     /** 监听网络状态变化。
      * @supported weapp, h5, rn
      * @example
@@ -84,6 +116,24 @@ declare module '../../index' {
       callback: onNetworkStatusChange.Callback,
     ): void
 
+    /** 取消监听弱网状态变化事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/network/wx.offNetworkWeakChange.html
+     */
+    offNetworkWeakChange(
+      /** 弱网状态变化事件的回调函数 */
+      callback: onNetworkWeakChange.Callback,
+    ): void
+
+    /** 取消监听网络状态变化事件，参数为空，则取消所有的事件监听。
+     * @supported weapp, h5, rn
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/network/wx.offNetworkStatusChange.html
+     */
+    offNetworkStatusChange(
+      /** 取消监听网络状态变化事件，参数为空，则取消所有的事件监听 */
+      callback?: onNetworkStatusChange.Callback,
+    ): void
+
     /** 获取网络类型。
      * @supported weapp, h5, rn
      * @example
@@ -100,15 +150,6 @@ declare module '../../index' {
      */
     getNetworkType(option?: getNetworkType.Option): Promise<getNetworkType.SuccessCallbackResult>
 
-    /** 取消监听网络状态变化事件，参数为空，则取消所有的事件监听。
-     * @supported weapp
-     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/network/wx.offNetworkStatusChange.html
-     */
-    offNetworkStatusChange(
-      /** 取消监听网络状态变化事件，参数为空，则取消所有的事件监听 */
-      callback?: (...args: any[]) => any,
-    ): void
-
     /** 获取局域网IP地址。
      * @supported weapp
      * @example