@tarojs/taro 3.8.0-canary.0 → 4.0.0-alpha.2

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, harmony_hybrid
      * @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, harmony_hybrid
      * @example
      * ```tsx
      * // 保持屏幕常亮
@@ -137,7 +137,7 @@ declare module '../../index' {
 
     /**
      * 监听用户主动截屏事件，用户使用系统截屏按键截屏时触发此事件
-     * @supported weapp, tt
+     * @supported weapp, alipay, swan, jd, tt, harmony_hybrid
      * @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(...)

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

@@ -90,6 +90,10 @@ declare module '../../index' {
 
   namespace getConnectedWifi {
     interface Option {
+      /** 是否需要返回部分 Wi-Fi 信息
+       * @default false
+       */
+      partialInfo?: boolean
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.WifiError) => void
       /** 接口调用失败的回调函数 */
@@ -113,6 +117,14 @@ declare module '../../index' {
       password: string
       /** Wi-Fi 设备 BSSID */
       BSSID?: string
+      /** 跳转到系统设置页进行连接
+       * @default false
+       */
+      maunal?: boolean
+      /** 是否需要返回部分 Wi-Fi 信息，仅安卓生效
+       * @default false
+       */
+      partialInfo?: boolean
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.WifiError) => void
       /** 接口调用失败的回调函数 */
@@ -142,7 +154,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 关闭 Wi-Fi 模块。
-     * @supported weapp
+     * @supported weapp, alipay, swan, jd
      * @example
      * ```tsx
      * Taro.stopWifi({
@@ -156,7 +168,7 @@ declare module '../../index' {
     stopWifi(option?: stopWifi.Option): Promise<TaroGeneral.WifiError>
 
     /** 初始化 Wi-Fi 模块。
-     * @supported weapp
+     * @supported weapp, alipay, swan, jd
      * @example
      * ```tsx
      * Taro.startWifi({
@@ -175,7 +187,7 @@ declare module '../../index' {
      * - 该接口只能在 `onGetWifiList` 回调之后才能调用。
      * - 此时客户端会挂起，等待小程序设置 Wi-Fi 信息，请务必尽快调用该接口，若无数据请传入一个空数组。
      * - 有可能随着周边 Wi-Fi 列表的刷新，单个流程内收到多次带有存在重复的 Wi-Fi 列表的回调。
-     * @supported weapp
+     * @supported weapp, swan, jd
      * @example
      * ```tsx
      * Taro.onGetWifiList(function (res) {
@@ -209,7 +221,7 @@ declare module '../../index' {
     ): void
 
     /** 监听连接上 Wi-Fi 的事件。
-     * @supported weapp
+     * @supported weapp, alipay, swan, jd
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.onWifiConnected.html
      */
     onWifiConnected(
@@ -218,7 +230,7 @@ declare module '../../index' {
     ): void
 
     /** 监听获取到 Wi-Fi 列表数据事件
-     * @supported weapp, tt
+     * @supported weapp, alipay, swan, jd, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.onGetWifiList.html
      */
     onGetWifiList(
@@ -232,39 +244,39 @@ declare module '../../index' {
      */
      offWifiConnectedWithPartialInfo(
       /** 连接上 Wi-Fi 的事件的回调函数 */
-      callback: onWifiConnectedWithPartialInfo.Callback,
+      callback?: onWifiConnectedWithPartialInfo.Callback,
     ): void
 
     /**
      * 取消监听连接上 Wi-Fi 的事件。
-     * @supported weapp
+     * @supported weapp, alipay, swan, jd
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.offWifiConnected.html
      */
     offWifiConnected(
       /** 连接上 Wi-Fi 的事件的回调函数 */
-      callback: onWifiConnected.Callback,
+      callback?: onWifiConnected.Callback,
     ): void
 
     /**
      * 取消监听获取到 Wi-Fi 列表数据事件。
-     * @supported weapp, tt
+     * @supported weapp, alipay, swan, jd, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.offGetWifiList.html
      */
     offGetWifiList(
       /** 获取到 Wi-Fi 列表数据事件的回调函数 */
-      callback: onGetWifiList.Callback,
+      callback?: onGetWifiList.Callback,
     ): void
 
     /** 请求获取 Wi-Fi 列表。在 `onGetWifiList` 注册的回调中返回 `wifiList` 数据。 **Android 调用前需要 [用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) scope.userLocation。**
      *
      * iOS 将跳转到系统的 Wi-Fi 界面，Android 不会跳转。 iOS 11.0 及 iOS 11.1 两个版本因系统问题，该方法失效。但在 iOS 11.2 中已修复。
-     * @supported weapp, tt
+     * @supported weapp, alipay, swan, jd, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.getWifiList.html
      */
     getWifiList(option?: getWifiList.Option): Promise<TaroGeneral.WifiError>
 
     /** 获取已连接中的 Wi-Fi 信息。
-     * @supported weapp
+     * @supported weapp, alipay, swan, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.getConnectedWifi.html
      */
     getConnectedWifi(option?: getConnectedWifi.Option): Promise<TaroGeneral.WifiError>
@@ -281,7 +293,7 @@ declare module '../../index' {
      *   }
      * })
      * ```
-     * @supported weapp
+     * @supported weapp,  alipay, swan,  jd
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.connectWifi.html
      */
     connectWifi(option: connectWifi.Option): Promise<TaroGeneral.WifiError>