@tarojs/taro/types/api/device/vibrate.d.ts

Taro framework

import Taro from '../../index'

declare module '../../index' {
  namespace vibrateShort {
    interface Option {
      /** 震动强度类型，有效值为：heavy、medium、light */
      type?: 'heavy' | 'medium' | 'light'
      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
      complete?: (res: TaroGeneral.CallbackResult) => void
      /** 接口调用失败的回调函数 */
      fail?: (res: TaroGeneral.CallbackResult) => void
      /** 接口调用成功的回调函数 */
      success?: (res: TaroGeneral.CallbackResult) => void
    }
  }

  namespace vibrateLong {
    interface Option {
      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
      complete?: (res: TaroGeneral.CallbackResult) => void
      /** 接口调用失败的回调函数 */
      fail?: (res: TaroGeneral.CallbackResult) => void
      /** 接口调用成功的回调函数 */
      success?: (res: TaroGeneral.CallbackResult) => void
    }
  }

  interface TaroStatic {
    /** 使手机发生较短时间的振动（15 ms）。仅在 iPhone `7 / 7 Plus` 以上及 Android 机型生效
     *
     * 仅微信小程序平台支持 type 参数
     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn, harmony
     * @example
     * ```tsx
     * Taro.vibrateShort(params).then(...)
     * ```
     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/vibrate/wx.vibrateShort.html
     */
    vibrateShort(option?: vibrateShort.Option): Promise<TaroGeneral.CallbackResult>

    /** 使手机发生较长时间的振动（400ms）
     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn, harmony
     * @example
     * ```tsx
     * Taro.vibrateLong(params).then(...)
     * ```
     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/vibrate/wx.vibrateLong.html
     */
    vibrateLong(option?: vibrateLong.Option): Promise<TaroGeneral.CallbackResult>
  }
}