@tarojs/taro 3.8.0-canary.0 → 4.0.0-beta.0

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

@@ -59,7 +59,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 停止监听罗盘数据
-     * @supported weapp, h5, tt
+     * @supported weapp, swan, qq, h5, tt
      * @example
      * ```tsx
      * Taro.stopCompass()
@@ -69,7 +69,7 @@ declare module '../../index' {
     stopCompass(option?: stopCompass.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 开始监听罗盘数据
-     * @supported weapp, h5, tt
+     * @supported weapp, swan, qq, h5, tt
      * @example
      * ```js
      * Taro.startCompass()
@@ -79,7 +79,7 @@ declare module '../../index' {
     startCompass(option?: startCompass.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 监听罗盘数据变化事件。频率：5 次/秒，接口调用后会自动开始监听，可使用 Taro.stopCompass 停止监听。
-     * @supported weapp, h5, tt
+     * @supported weapp, swan, qq, h5, tt
      * @example
      * ```tsx
      * Taro.onCompassChange(function (res) {
@@ -94,12 +94,12 @@ declare module '../../index' {
     ): void
 
     /** 取消监听罗盘数据变化事件，参数为空，则取消所有的事件监听。
-     * @supported weapp, h5
+     * @supported weapp, swan, qq, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/compass/wx.offCompassChange.html
      */
     offCompassChange(
       /** 罗盘数据变化事件的回调函数 */
-      callback: (...args: any[]) => any,
+      callback?: onCompassChange.Callback,
     ): void
   }
 }

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

@@ -53,7 +53,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 停止监听陀螺仪数据。
-     * @supported weapp, rn, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, rn
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/gyroscope/wx.stopGyroscope.html
      */
     stopGyroscope(option?: stopGyroscope.Option): Promise<TaroGeneral.CallbackResult>
@@ -65,7 +65,7 @@ declare module '../../index' {
     startGyroscope(option: startGyroscope.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 监听陀螺仪数据变化事件。频率根据 Taro.startGyroscope() 的 interval 参数。可以使用 Taro.stopGyroscope() 停止监听。
-     * @supported weapp, rn, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, rn
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/gyroscope/wx.onGyroscopeChange.html
      */
     onGyroscopeChange(
@@ -74,12 +74,12 @@ declare module '../../index' {
     ): void
 
     /** 取消监听陀螺仪数据变化事件。
-     * @supported weapp, rn, tt
+     * @supported weapp, alipay, swan, jd, tt, rn
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/gyroscope/wx.offGyroscopeChange.html
      */
     offGyroscopeChange(
       /** 陀螺仪数据变化事件的回调函数 */
-      callback?: (...args: any[]) => any,
+      callback?: onGyroscopeChange.Callback,
     ): void
   }
 }

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

@@ -20,7 +20,9 @@ declare module '../../index' {
       complete?: (res: TaroGeneral.IBeaconError) => void
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.IBeaconError) => void
-      /** 是否校验蓝牙开关，仅在 iOS 下有效 */
+      /** 是否校验蓝牙开关，仅在 iOS 下有效
+       * @default false
+       */
       ignoreBluetoothAvailable?: boolean
       /** 接口调用成功的回调函数 */
       success?: (res: TaroGeneral.IBeaconError) => void
@@ -100,7 +102,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 停止搜索附近的 iBeacon 设备
-     * @supported weapp
+     * @supported weapp, alipay
      * @example
      * ```tsx
      * Taro.stopBeaconDiscovery(params).then(...)
@@ -110,7 +112,7 @@ declare module '../../index' {
     stopBeaconDiscovery(option?: stopBeaconDiscovery.Option): Promise<TaroGeneral.IBeaconError>
 
     /** 开始搜索附近的 iBeacon 设备
-     * @supported weapp
+     * @supported weapp, alipay
      * @example
      * ```tsx
      * Taro.startBeaconDiscovery({
@@ -122,7 +124,7 @@ declare module '../../index' {
     startBeaconDiscovery(option: startBeaconDiscovery.Option): Promise<TaroGeneral.IBeaconError>
 
     /** 监听 iBeacon 设备更新事件，仅能注册一个监听
-     * @supported weapp
+     * @supported weapp, alipay
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.onBeaconUpdate.html
      */
     onBeaconUpdate(
@@ -131,7 +133,7 @@ declare module '../../index' {
     ): void
 
     /** 监听 iBeacon 服务状态变化事件，仅能注册一个监听
-     * @supported weapp
+     * @supported weapp, alipay
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.onBeaconServiceChange.html
      */
     onBeaconServiceChange(
@@ -140,7 +142,7 @@ declare module '../../index' {
     ): void
 
     /** 取消监听 iBeacon 设备更新事件
-     * @supported weapp
+     * @supported weapp, alipay
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.offBeaconUpdate.html
      */
     offBeaconUpdate(
@@ -149,7 +151,7 @@ declare module '../../index' {
     ): void
 
     /** 取消监听 iBeacon 服务状态变化事件
-     * @supported weapp
+     * @supported weapp, alipay
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.offBeaconServiceChange.html
      */
     offBeaconServiceChange(
@@ -158,7 +160,7 @@ declare module '../../index' {
     ): void
 
     /** 获取所有已搜索到的 iBeacon 设备
-     * @supported weapp
+     * @supported weapp, alipay
      * @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/keyboard.d.ts

@@ -43,7 +43,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 在input、textarea等focus拉起键盘之后，手动调用此接口收起键盘
-     * @supported weapp, rn, tt
+     * @supported weapp, alipay, swan, jd, tt, rn
      * @example
      * ```tsx
      * Taro.hideKeyboard({
@@ -71,7 +71,7 @@ declare module '../../index' {
     getSelectedTextRange(option?: getSelectedTextRange.Option): Promise<getSelectedTextRange.SuccessCallbackResult>
 
     /** 监听键盘高度变化
-     * @supported weapp, rn
+     * @supported weapp, swan, jd, qq, rn, harmony
      * @example
      * ```tsx
      * Taro.onKeyboardHeightChange(res => {
@@ -80,16 +80,18 @@ declare module '../../index' {
      * ```
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.onKeyboardHeightChange.html
      */
-    onKeyboardHeightChange(callback: onKeyboardHeightChange.Callback): void
+    onKeyboardHeightChange(
+      callback: onKeyboardHeightChange.Callback
+    ): void
 
     /**
      * 取消监听键盘高度变化事件。
-     * @supported weapp, rn
+     * @supported weapp, swan, jd, rn, harmony
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.offKeyboardHeightChange.html
      */
     offKeyboardHeightChange(
       /** 键盘高度变化事件的回调函数 */
-      callback?: (...args: any[]) => any,
+      callback?: onKeyboardHeightChange.Callback
     ): void
   }
 }

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

@@ -26,7 +26,7 @@ declare module '../../index' {
     /** 监听内存不足告警事件。
      *
      * 当 iOS/Android 向小程序进程发出内存警告时，触发该事件。触发该事件不意味小程序被杀，大部分情况下仅仅是告警，开发者可在收到通知后回收一些不必要资源避免进一步加剧内存紧张。
-     * @supported weapp, tt
+     * @supported weapp, alipay, swan, jd, tt
      * @example
      * ```tsx
      * Taro.onMemoryWarning(function () {
@@ -41,13 +41,12 @@ declare module '../../index' {
     ): void
 
     /** 取消监听内存不足告警事件。
-     * @supported weapp
+     * @supported weapp, alipay, swan
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/memory/wx.offMemoryWarning.html
      */
     offMemoryWarning(
       /** 取消监听内存不足告警事件 */
-      callback: onMemoryWarning.Callback,
+      callback?: onMemoryWarning.Callback,
     ): void
-
   }
 }

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

@@ -51,7 +51,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 开始监听设备方向的变化。
-     * @supported weapp, h5, rn
+     * @supported weapp, swan, jd, h5, rn
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/motion/wx.startDeviceMotionListening.html
      */
     startDeviceMotionListening(
@@ -60,7 +60,7 @@ declare module '../../index' {
 
     /**
      * 停止监听设备方向的变化。
-     * @supported weapp, h5, rn
+     * @supported weapp, swan, jd, h5, rn
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/motion/wx.stopDeviceMotionListening.html
      */
     stopDeviceMotionListening(
@@ -69,18 +69,20 @@ declare module '../../index' {
 
     /**
      * 监听设备方向变化事件。频率根据 Taro.startDeviceMotionListening() 的 interval 参数。可以使用 Taro.stopDeviceMotionListening() 停止监听。
-     * @supported weapp, h5, rn
+     * @supported weapp, alipay, swan, jd, h5, rn
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/motion/wx.onDeviceMotionChange.html
      */
-    onDeviceMotionChange (callback: onDeviceMotionChange.Callback): void
+    onDeviceMotionChange(
+      callback: onDeviceMotionChange.Callback
+    ): void
 
     /** 取消监听设备方向变化事件，参数为空，则取消所有的事件监听。
-     * @supported weapp, h5, rn
+     * @supported weapp, alipay, swan, jd, h5, rn
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/motion/wx.offDeviceMotionChange.html
      */
     offDeviceMotionChange(
       /** 设备方向变化事件的回调函数 */
-      callback?: (...args: any[]) => any,
+      callback?: onDeviceMotionChange.Callback
     ): void
   }
 }

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

@@ -41,6 +41,10 @@ declare module '../../index' {
     interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 网络类型 */
       networkType: keyof NetworkType
+      /** 信号强弱，单位 dbm */
+      signalStrength?: number
+      /** 设备是否使用了网络代理 */
+      hasSystemProxy?: boolean
       /** 调用结果 */
       errMsg: string
     }
@@ -76,6 +80,8 @@ declare module '../../index' {
     interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 本机局域网IP地址 */
       localip: string
+      /** ，基础库 2.24.0 开始支持 */
+      netmask?: string
       /** 调用结果 */
       errMsg: string
     }
@@ -83,7 +89,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 监听弱网状态变化事件
-     * @supported weapp
+     * @supported weapp, swan, qq, tt
      * @example
      * ```tsx
      * Taro.onNetworkWeakChange(function (res) {
@@ -101,7 +107,7 @@ declare module '../../index' {
     ): void
 
     /** 监听网络状态变化。
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, swan, h5, rn, tt, harmony
      * @example
      * ```tsx
      * Taro.onNetworkStatusChange(function (res) {
@@ -117,16 +123,16 @@ declare module '../../index' {
     ): void
 
     /** 取消监听弱网状态变化事件
-     * @supported weapp
+     * @supported weapp, swan
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/network/wx.offNetworkWeakChange.html
      */
     offNetworkWeakChange(
       /** 弱网状态变化事件的回调函数 */
-      callback: onNetworkWeakChange.Callback,
+      callback?: onNetworkWeakChange.Callback,
     ): void
 
     /** 取消监听网络状态变化事件，参数为空，则取消所有的事件监听。
-     * @supported weapp, h5, rn
+     * @supported weapp, swan, h5, rn, harmony
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/network/wx.offNetworkStatusChange.html
      */
     offNetworkStatusChange(
@@ -135,7 +141,7 @@ declare module '../../index' {
     ): void
 
     /** 获取网络类型。
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, swan, qq, h5, rn, tt, harmony
      * @example
      * ```tsx
      * Taro.getNetworkType({

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

@@ -187,7 +187,7 @@ declare module '../../index' {
     namespace transceive {
       interface Option {
         /** 需要传递的二进制数据 */
-        transceive: ArrayBuffer
+        data: ArrayBuffer
         /** 接口调用结束的回调函数（调用成功、失败都会执行） */
         complete?: (res: TaroGeneral.NFCError) => void
         /** 接口调用失败的回调函数 */
@@ -298,7 +298,7 @@ declare module '../../index' {
     namespace transceive {
       interface Option {
         /** 需要传递的二进制数据 */
-        transceive: ArrayBuffer
+        data: ArrayBuffer
         /** 接口调用结束的回调函数（调用成功、失败都会执行） */
         complete?: (res: TaroGeneral.NFCError) => void
         /** 接口调用失败的回调函数 */
@@ -409,7 +409,7 @@ declare module '../../index' {
     namespace transceive {
       interface Option {
         /** 需要传递的二进制数据 */
-        transceive: ArrayBuffer
+        data: ArrayBuffer
         /** 接口调用结束的回调函数（调用成功、失败都会执行） */
         complete?: (res: TaroGeneral.NFCError) => void
         /** 接口调用失败的回调函数 */
@@ -521,11 +521,11 @@ declare module '../../index' {
     namespace writeNdefMessage {
       interface Option {
         /** uri 数组 */
-        uris: string[]
+        uris?: string[]
         /** text 数组 */
-        texts: string[]
+        texts?: string[]
         /** 二进制对象数组, 需要指明 id, type 以及 payload (均为 ArrayBuffer 类型) */
-        records: record[]
+        records?: record[]
         /** 接口调用结束的回调函数（调用成功、失败都会执行） */
         complete?: (res: TaroGeneral.NFCError) => void
         /** 接口调用失败的回调函数 */
@@ -676,7 +676,7 @@ declare module '../../index' {
     namespace transceive {
       interface Option {
         /** 需要传递的二进制数据 */
-        transceive: ArrayBuffer
+        data: ArrayBuffer
         /** 接口调用结束的回调函数（调用成功、失败都会执行） */
         complete?: (res: TaroGeneral.NFCError) => void
         /** 接口调用失败的回调函数 */
@@ -741,7 +741,7 @@ declare module '../../index' {
      */
     offDiscovered(
       /** 监听 NFC Tag的回调函数 */
-      callback: NFCAdapter.onDiscovered.Callback,
+      callback?: NFCAdapter.onDiscovered.Callback,
     ): void
     /** 监听 NFC Tag
      * @supported weapp, tt
@@ -778,7 +778,7 @@ declare module '../../index' {
         /** NFC标签的UID
          * @supported tt
          */
-        uid?: ArrayBuffer
+        id?: ArrayBuffer
       }
 
       interface NdefMessage {
@@ -906,7 +906,7 @@ declare module '../../index' {
     namespace transceive {
       interface Option {
         /** 需要传递的二进制数据 */
-        transceive: ArrayBuffer
+        data: ArrayBuffer
         /** 接口调用结束的回调函数（调用成功、失败都会执行） */
         complete?: (res: TaroGeneral.NFCError) => void
         /** 接口调用失败的回调函数 */
@@ -1017,7 +1017,7 @@ declare module '../../index' {
     namespace transceive {
       interface Option {
         /** 需要传递的二进制数据 */
-        transceive: ArrayBuffer
+        data: ArrayBuffer
         /** 接口调用结束的回调函数（调用成功、失败都会执行） */
         complete?: (res: TaroGeneral.NFCError) => void
         /** 接口调用失败的回调函数 */
@@ -1128,7 +1128,7 @@ declare module '../../index' {
     namespace transceive {
       interface Option {
         /** 需要传递的二进制数据 */
-        transceive: ArrayBuffer
+        data: ArrayBuffer
         /** 接口调用结束的回调函数（调用成功、失败都会执行） */
         complete?: (res: TaroGeneral.NFCError) => void
         /** 接口调用失败的回调函数 */
@@ -1212,7 +1212,7 @@ declare module '../../index' {
      */
     offHCEMessage(
       /** 接收 NFC 设备消息事件的回调函数 */
-      callback: (...args: any[]) => any,
+      callback: onHCEMessage.Callback,
     ): void
 
     /** 获取 NFC 实例

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

@@ -16,7 +16,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 拨打电话
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, swan, jd, qq, tt, h5, rn, harmony
      * @example
      * ```tsx
      * Taro.makePhoneCall({

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

@@ -7,7 +7,9 @@ declare module '../../index' {
       complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
-      /** 是否只能从相机扫码，不允许从相册选择图片 */
+      /** 是否只能从相机扫码，不允许从相册选择图片
+       * @default false
+       */
       onlyFromCamera?: boolean
       /** 扫码类型 */
       scanType?: (keyof ScanType)[]
@@ -85,7 +87,7 @@ declare module '../../index' {
   interface TaroStatic {
     /**
      * 调起客户端扫码界面，扫码成功后返回对应的结果
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, swan, jd, qq, tt, h5, rn
      * @example
      * ```tsx
      * // 允许从相机和相册扫码
@@ -94,7 +96,7 @@ declare module '../../index' {
      *     console.log(res)
      *   }
      * })
-     *       // 只允许从相机扫码
+     * // 只允许从相机扫码
      * Taro.scanCode({
      *   onlyFromCamera: true,
      *   success: (res) => {

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

@@ -77,10 +77,10 @@ declare module '../../index' {
       success?: (option: SuccessCallbackResult) => void
     }
     interface ScreenRecordingState {
-      /** 开始录屏 */
-      start
-      /** 结束录屏 */
-      stop
+      /** 开启 */
+      on
+      /** 关闭 */
+      off
     }
     interface SuccessCallbackResult {
       /** 录屏状态 */
@@ -106,13 +106,13 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 设置截屏/录屏时屏幕表现，仅支持在 Android 端调用
-     * @supported weapp
+     * @supported weapp, alipay
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.setVisualEffectOnCapture.html
      */
     setVisualEffectOnCapture(option: setVisualEffectOnCapture.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 设置屏幕亮度。
-     * @supported weapp, rn, tt
+     * @supported weapp, swan, jd, qq, tt, rn
      * @example
      * ```tsx
      * Taro.setScreenBrightness(params).then(...)
@@ -123,7 +123,7 @@ declare module '../../index' {
 
     /**
      * 设置是否保持常亮状态。仅在当前小程序生效，离开小程序后设置失效。
-     * @supported weapp, rn, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, rn
      * @example
      * ```tsx
      * // 保持屏幕常亮
@@ -137,7 +137,7 @@ declare module '../../index' {
 
     /**
      * 监听用户主动截屏事件，用户使用系统截屏按键截屏时触发此事件
-     * @supported weapp, tt
+     * @supported weapp, alipay, swan, jd, tt
      * @example
      * ```tsx
      * Taro.onUserCaptureScreen(function (res) {
@@ -154,6 +154,14 @@ declare module '../../index' {
     /** 监听用户录屏事件
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.onScreenRecordingStateChanged.html
+     * @example
+     * ```tsx
+     * // 监听用户录屏事件
+     * const handler = function (res) {
+     *     console.log(res.state)
+     * }
+     * Taro.onScreenRecordingStateChanged(handler)
+     * ```
      */
     onScreenRecordingStateChanged(
       /** 用户录屏事件的监听函数 */
@@ -161,7 +169,7 @@ declare module '../../index' {
     ): void
 
     /** 用户主动截屏事件。取消事件监听。
-     * @supported weapp, tt
+     * @supported weapp, alipay, swan, jd, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.offUserCaptureScreen.html
      */
     offUserCaptureScreen(
@@ -171,16 +179,24 @@ declare module '../../index' {
 
     /** 取消用户录屏事件的监听函数
      * @supported weapp
-     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.offScreenRecordingStateChanged.html 
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.offScreenRecordingStateChanged.html
      */
     offScreenRecordingStateChanged(
       /** 用户录屏事件的监听函数 */
-      callback: onScreenRecordingStateChanged.Callback
+      callback?: onScreenRecordingStateChanged.Callback
     ): void
 
     /** 查询用户是否在录屏
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.getScreenRecordingState.html
+     * @example
+     * ```tsx
+     * Taro.getScreenRecordingState({
+     *     success: function (res) {
+     *         console.log(res.state)
+     *     },
+     * })
+     * ```
      */
     getScreenRecordingState(
       option?: getScreenRecordingState.Option
@@ -191,7 +207,7 @@ declare module '../../index' {
      *
      * **说明**
      * - 若安卓系统设置中开启了自动调节亮度功能，则屏幕亮度会根据光线自动调整，该接口仅能获取自动调节亮度之前的值，而非实时的亮度值。
-     * @supported weapp, rn, tt
+     * @supported weapp, alipay, swan, jd, qq, rn, harmony
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.getScreenBrightness.html
      */
     getScreenBrightness(

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

@@ -18,7 +18,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 拉起手机发送短信界面
-     * @supported weap
+     * @supported weapp, tt
      * @see declare module '../../index' 
      */
     sendSms(option: sendSms.Option): Promise<TaroGeneral.CallbackResul>

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

@@ -4,7 +4,7 @@ declare module '../../index' {
   namespace vibrateShort {
     interface Option {
       /** 震动强度类型，有效值为：heavy、medium、light */
-      type: 'heavy' | 'medium' | 'light'
+      type?: 'heavy' | 'medium' | 'light'
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
@@ -27,9 +27,9 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 使手机发生较短时间的振动（15 ms）。仅在 iPhone `7 / 7 Plus` 以上及 Android 机型生效
-     * @h5 不支持 type 参数
-     * @rn 不支持 type 参数
-     * @supported weapp, h5, rn, tt
+     *
+     * 仅微信小程序平台支持 type 参数
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn, harmony
      * @example
      * ```tsx
      * Taro.vibrateShort(params).then(...)
@@ -39,7 +39,7 @@ declare module '../../index' {
     vibrateShort(option?: vibrateShort.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 使手机发生较长时间的振动（400ms）
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn, harmony
      * @example
      * ```tsx
      * Taro.vibrateLong(params).then(...)