@tarojs/taro 3.3.13 → 3.3.17

package/types/api/ui/animation.d.ts

@@ -1,4 +1,6 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace createAnimation {
     interface Option {
       /** 动画延迟时间，单位 ms */
@@ -27,28 +29,13 @@ declare namespace Taro {
     }
   }
 
-  /** 创建一个动画实例 animation。调用实例的方法来描述动画。最后通过动画实例的 export 方法导出动画数据传递给组件的 animation 属性。
-   * @supported weapp, h5
-   * @example
-   * ```tsx
-   * var animation = Taro.createAnimation({
-   *   transformOrigin: "50% 50%",
-   *   duration: 1000,
-   *   timingFunction: "ease",
-   *   delay: 0
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/wx.createAnimation.html
-   */
-  function createAnimation(option: createAnimation.Option): Animation
-
   interface Animation {
     /** 导出动画队列。**export 方法每次调用后会清掉之前的动画操作。**
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/Animation.export.html
      */
     export(): {
-      actions: General.IAnyObject[]
+      actions: TaroGeneral.IAnyObject[]
     }
     /** 设置背景色
      * @supported weapp
@@ -465,4 +452,21 @@ declare namespace Taro {
     /** 起始和结束的滚动范围映射的时间长度，该时间可用于与关键帧动画里的时间 (duration) 相匹配，单位 ms */
     timeRange: number
   }
+
+  interface TaroStatic {
+    /** 创建一个动画实例 animation。调用实例的方法来描述动画。最后通过动画实例的 export 方法导出动画数据传递给组件的 animation 属性。
+     * @supported weapp, h5
+     * @example
+     * ```tsx
+     * var animation = Taro.createAnimation({
+     *   transformOrigin: "50% 50%",
+     *   duration: 1000,
+     *   timingFunction: "ease",
+     *   delay: 0
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/animation/wx.createAnimation.html
+     */
+    createAnimation(option: createAnimation.Option): Animation
+  }
 }

package/types/api/ui/background.d.ts

@@ -1,4 +1,6 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace setBackgroundTextStyle {
     interface Option {
       /** 下拉背景字体、loading 图的样式。
@@ -8,26 +10,14 @@ declare namespace Taro {
        * - 'light': light 样式; */
       textStyle: 'dark' | 'light'
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
-      success?: (res: General.CallbackResult) => void
+      success?: (res: TaroGeneral.CallbackResult) => void
     }
   }
 
-  /** 动态设置下拉背景字体、loading 图的样式
-   * @supported weapp
-   * @example
-   * ```tsx
-   * Taro.setBackgroundTextStyle({
-   *   textStyle: 'dark' // 下拉背景字体、loading 图的样式为dark
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/background/wx.setBackgroundTextStyle.html
-   */
-  function setBackgroundTextStyle(option: setBackgroundTextStyle.Option): Promise<General.CallbackResult>
-
   namespace setBackgroundColor {
     interface Option {
       /** 窗口的背景色，必须为十六进制颜色值 */
@@ -37,27 +27,41 @@ declare namespace Taro {
       /** 顶部窗口的背景色，必须为十六进制颜色值，仅 iOS 支持 */
       backgroundColorTop?: string
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
-      success?: (res: General.CallbackResult) => void
+      success?: (res: TaroGeneral.CallbackResult) => void
     }
   }
 
-  /** 动态设置窗口的背景色
-   * @supported weapp
-   * @example
-   * ```tsx
-   * Taro.setBackgroundColor({
-   *   backgroundColor: '#ffffff', // 窗口的背景色为白色
-   * })
-   * Taro.setBackgroundColor({
-   *   backgroundColorTop: '#ffffff', // 顶部窗口的背景色为白色
-   *   backgroundColorBottom: '#ffffff', // 底部窗口的背景色为白色
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/background/wx.setBackgroundColor.html
-   */
-  function setBackgroundColor(option: setBackgroundColor.Option): Promise<General.CallbackResult>
+  interface TaroStatic {
+    /** 动态设置下拉背景字体、loading 图的样式
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.setBackgroundTextStyle({
+     *   textStyle: 'dark' // 下拉背景字体、loading 图的样式为dark
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/background/wx.setBackgroundTextStyle.html
+     */
+    setBackgroundTextStyle(option: setBackgroundTextStyle.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 动态设置窗口的背景色
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.setBackgroundColor({
+     *   backgroundColor: '#ffffff', // 窗口的背景色为白色
+     * })
+     * Taro.setBackgroundColor({
+     *   backgroundColorTop: '#ffffff', // 顶部窗口的背景色为白色
+     *   backgroundColorBottom: '#ffffff', // 底部窗口的背景色为白色
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/background/wx.setBackgroundColor.html
+     */
+    setBackgroundColor(option: setBackgroundColor.Option): Promise<TaroGeneral.CallbackResult>
+  }
 }

package/types/api/ui/custom-component.d.ts

@@ -1,19 +1,23 @@
-declare namespace Taro {
-  /** 延迟一部分操作到下一个时间片再执行。（类似于 setTimeout）
-   *
-   * **说明**
-   * 因为自定义组件中的 setData 和 triggerEvent 等接口本身是同步的操作，当这几个接口被连续调用时，都是在一个同步流程中执行完的，因此若逻辑不当可能会导致出错。
-   * 一个极端的案例：当父组件的 setData 引发了子组件的 triggerEvent，进而使得父组件又进行了一次 setData，期间有通过 wx:if 语句对子组件进行卸载，就有可能引发奇怪的错误，所以对于不需要在一个同步流程内完成的逻辑，可以使用此接口延迟到下一个时间片再执行。
-   * @supported weapp
-   * @example
-   * ```tsx
-   * this.setData({ number: 1 }) // 直接在当前同步流程中执行
-   * Taro.nextTick(() => {
-   *   this.setData({ number: 3 }) // 在当前同步流程结束后，下一个时间片执行
-   * })
-   * this.setData({ number: 2 }) // 直接在当前同步流程中执行
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/custom-component/wx.nextTick.html
-   */
-  function nextTick(callback: (...args: any[]) => any): void
+import Taro from '../../index'
+
+declare module '../../index' {
+  interface TaroStatic {
+    /** 延迟一部分操作到下一个时间片再执行。（类似于 setTimeout）
+     *
+     * **说明**
+     * 因为自定义组件中的 setData 和 triggerEvent 等接口本身是同步的操作，当这几个接口被连续调用时，都是在一个同步流程中执行完的，因此若逻辑不当可能会导致出错。
+     * 一个极端的案例：当父组件的 setData 引发了子组件的 triggerEvent，进而使得父组件又进行了一次 setData，期间有通过 wx:if 语句对子组件进行卸载，就有可能引发奇怪的错误，所以对于不需要在一个同步流程内完成的逻辑，可以使用此接口延迟到下一个时间片再执行。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * this.setData({ number: 1 }) // 直接在当前同步流程中执行
+     * Taro.nextTick(() => {
+     *   this.setData({ number: 3 }) // 在当前同步流程结束后，下一个时间片执行
+     * })
+     * this.setData({ number: 2 }) // 直接在当前同步流程中执行
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/custom-component/wx.nextTick.html
+     */
+    nextTick(callback: (...args: any[]) => any): void
+  }
 }

package/types/api/ui/fonts.d.ts

@@ -1,4 +1,6 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace loadFontFace {
     interface Option {
       /** 是否全局生效
@@ -52,24 +54,27 @@ declare namespace Taro {
       status: string
     }
   }
-  /** 动态加载网络字体。文件地址需为下载类型。iOS 仅支持 https 格式文件地址。
-   *
-   * 注意：
-   * 1. 字体文件返回的 contet-type 参考 [font](https://www.iana.org/assignments/media-types/media-types.xhtml#font)，格式不正确时会解析失败。
-   * 2. 字体链接必须是https（ios不支持http)
-   * 3. 字体链接必须是同源下的，或开启了cors支持，小程序的域名是`servicewechat.com`
-   * 4. canvas等原生组件不支持使用接口添加的字体
-   * 5. 工具里提示 Faild to load font可以忽略
-   * @supported weapp
-   * @example
-   * ```tsx
-   * Taro.loadFontFace({
-   *   family: 'Bitstream Vera Serif Bold',
-   *   source: 'url("https://sungd.github.io/Pacifico.ttf")',
-   *   success: console.log
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/font/wx.loadFontFace.html
-   */
-  function loadFontFace(option: loadFontFace.Option): void
+
+  interface TaroStatic {
+    /** 动态加载网络字体。文件地址需为下载类型。iOS 仅支持 https 格式文件地址。
+     *
+     * 注意：
+     * 1. 字体文件返回的 contet-type 参考 [font](https://www.iana.org/assignments/media-types/media-types.xhtml#font)，格式不正确时会解析失败。
+     * 2. 字体链接必须是https（ios不支持http)
+     * 3. 字体链接必须是同源下的，或开启了cors支持，小程序的域名是`servicewechat.com`
+     * 4. canvas等原生组件不支持使用接口添加的字体
+     * 5. 工具里提示 Faild to load font可以忽略
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.loadFontFace({
+     *   family: 'Bitstream Vera Serif Bold',
+     *   source: 'url("https://sungd.github.io/Pacifico.ttf")',
+     *   success: console.log
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/font/wx.loadFontFace.html
+     */
+    loadFontFace(option: loadFontFace.Option): void
+  }
 }