@tarojs/taro 3.3.12 → 3.3.16

package/types/api/ui/tab-bar.d.ts

@@ -1,42 +1,32 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace showTabBarRedDot {
     interface Option {
       /** tabBar 的哪一项，从左边算起 */
       index: number
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      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
     }
   }
 
-  /** 显示 tabBar 某一项的右上角的红点
-   * @supported weapp, h5
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.showTabBarRedDot.html
-   */
-  function showTabBarRedDot(option: showTabBarRedDot.Option): Promise<General.CallbackResult>
-
   namespace showTabBar {
     interface Option {
       /** 是否需要动画效果 */
       animation?: boolean
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      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
     }
   }
 
-  /** 显示 tabBar
-   * @supported weapp, h5
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.showTabBar.html
-   */
-  function showTabBar(option?: showTabBar.Option): Promise<General.CallbackResult>
-
   namespace setTabBarStyle {
     interface Option {
       /** tab 的背景色，HexColor */
@@ -46,65 +36,35 @@ declare namespace Taro {
       /** tab 上的文字默认颜色，HexColor */
       color?: string
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** tab 上的文字选中时的颜色，HexColor */
       selectedColor?: string
       /** 接口调用成功的回调函数 */
-      success?: (res: General.CallbackResult) => void
+      success?: (res: TaroGeneral.CallbackResult) => void
     }
   }
 
-  /** 动态设置 tabBar 的整体样式
-   * @supported weapp, h5
-   * @example
-   * ```tsx
-   * Taro.setTabBarStyle({
-   *   color: '#FF0000',
-   *   selectedColor: '#00FF00',
-   *   backgroundColor: '#0000FF',
-   *   borderStyle: 'white'
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.setTabBarStyle.html
-   */
-  function setTabBarStyle(option?: setTabBarStyle.Option): Promise<General.CallbackResult>
-
   namespace setTabBarItem {
     interface Option {
       /** tabBar 的哪一项，从左边算起 */
       index: number
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 图片路径，icon 大小限制为 40kb，建议尺寸为 81px * 81px，当 postion 为 top 时，此参数无效 */
       iconPath?: string
       /** 选中时的图片路径，icon 大小限制为 40kb，建议尺寸为 81px * 81px ，当 postion 为 top 时，此参数无效 */
       selectedIconPath?: string
       /** 接口调用成功的回调函数 */
-      success?: (res: General.CallbackResult) => void
+      success?: (res: TaroGeneral.CallbackResult) => void
       /** tab 上的按钮文字 */
       text?: string
     }
   }
 
-  /** 动态设置 tabBar 某一项的内容，`2.7.0` 起图片支持临时文件和网络文件。
-   * @supported weapp, h5, rn
-   * @example
-   * ```tsx
-   * Taro.setTabBarItem({
-   *   index: 0,
-   *   text: 'text',
-   *   iconPath: '/path/to/iconPath',
-   *   selectedIconPath: '/path/to/selectedIconPath'
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.setTabBarItem.html
-   */
-  function setTabBarItem(option: setTabBarItem.Option): Promise<General.CallbackResult>
-
   namespace setTabBarBadge {
     interface Option {
       /** tabBar 的哪一项，从左边算起 */
@@ -112,81 +72,125 @@ declare namespace Taro {
       /** 显示的文本，超过 4 个字符则显示成 ... */
       text: 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
     }
   }
 
-  /** 为 tabBar 某一项的右上角添加文本
-   * @supported weapp, h5
-   * @example
-   * ```tsx
-   * Taro.setTabBarBadge({
-   *   index: 0,
-   *   text: '1'
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.setTabBarBadge.html
-   */
-  function setTabBarBadge(option: setTabBarBadge.Option): Promise<General.CallbackResult>
-
   namespace removeTabBarBadge {
     interface Option {
       /** tabBar 的哪一项，从左边算起 */
       index: number
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      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
     }
   }
 
-  /** 移除 tabBar 某一项右上角的文本
-   * @supported weapp, h5
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.removeTabBarBadge.html
-   */
-  function removeTabBarBadge(option: removeTabBarBadge.Option): Promise<General.CallbackResult>
-
   namespace hideTabBarRedDot {
     interface Option {
       /** tabBar 的哪一项，从左边算起 */
       index: number
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      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
     }
   }
 
-  /** 隐藏 tabBar 某一项的右上角的红点
-   * @supported weapp, h5
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.hideTabBarRedDot.html
-   */
-  function hideTabBarRedDot(option: hideTabBarRedDot.Option): Promise<General.CallbackResult>
-
   namespace hideTabBar {
     interface Option {
       /** 是否需要动画效果 */
       animation?: boolean
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      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
     }
   }
 
-  /** 隐藏 tabBar
-   * @supported weapp, h5
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.hideTabBar.html
-   */
-  function hideTabBar(option?: hideTabBar.Option): Promise<General.CallbackResult>
+  interface TaroStatic {
+    /** 显示 tabBar 某一项的右上角的红点
+     * @supported weapp, h5
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.showTabBarRedDot.html
+     */
+    showTabBarRedDot(option: showTabBarRedDot.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 显示 tabBar
+     * @supported weapp, h5
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.showTabBar.html
+     */
+    showTabBar(option?: showTabBar.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 动态设置 tabBar 的整体样式
+     * @supported weapp, h5
+     * @example
+     * ```tsx
+     * Taro.setTabBarStyle({
+     *   color: '#FF0000',
+     *   selectedColor: '#00FF00',
+     *   backgroundColor: '#0000FF',
+     *   borderStyle: 'white'
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.setTabBarStyle.html
+     */
+    setTabBarStyle(option?: setTabBarStyle.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 动态设置 tabBar 某一项的内容，`2.7.0` 起图片支持临时文件和网络文件。
+     * @supported weapp, h5, rn
+     * @example
+     * ```tsx
+     * Taro.setTabBarItem({
+     *   index: 0,
+     *   text: 'text',
+     *   iconPath: '/path/to/iconPath',
+     *   selectedIconPath: '/path/to/selectedIconPath'
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.setTabBarItem.html
+     */
+    setTabBarItem(option: setTabBarItem.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 为 tabBar 某一项的右上角添加文本
+     * @supported weapp, h5
+     * @example
+     * ```tsx
+     * Taro.setTabBarBadge({
+     *   index: 0,
+     *   text: '1'
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.setTabBarBadge.html
+     */
+    setTabBarBadge(option: setTabBarBadge.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 移除 tabBar 某一项右上角的文本
+     * @supported weapp, h5
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.removeTabBarBadge.html
+     */
+    removeTabBarBadge(option: removeTabBarBadge.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 隐藏 tabBar 某一项的右上角的红点
+     * @supported weapp, h5
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.hideTabBarRedDot.html
+     */
+    hideTabBarRedDot(option: hideTabBarRedDot.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 隐藏 tabBar
+     * @supported weapp, h5
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.hideTabBar.html
+     */
+    hideTabBar(option?: hideTabBar.Option): Promise<TaroGeneral.CallbackResult>
+  }
 }

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

@@ -1,4 +1,6 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace onWindowResize {
     /** 窗口尺寸变化事件的回调函数 */
     type Callback = (result: CallbackResult) => void
@@ -14,25 +16,29 @@ declare namespace Taro {
       windowWidth: number
     }
   }
-  /** 监听窗口尺寸变化事件
-   * @supported weapp, h5
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/window/wx.onWindowResize.html
-   */
-  function onWindowResize(
-    /** 窗口尺寸变化事件的回调函数 */
-    callback: onWindowResize.Callback,
-  ): void
 
   namespace offWindowResize {
     /** 窗口尺寸变化事件的回调函数 */
-    type Callback = (res: General.CallbackResult) => void
+    type Callback = (res: TaroGeneral.CallbackResult) => void
+  }
+
+  interface TaroStatic {
+    /** 监听窗口尺寸变化事件
+     * @supported weapp, h5
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/window/wx.onWindowResize.html
+     */
+    onWindowResize(
+      /** 窗口尺寸变化事件的回调函数 */
+      callback: onWindowResize.Callback,
+    ): void
+
+    /** 取消监听窗口尺寸变化事件
+     * @supported weapp, h5
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/window/wx.offWindowResize.html
+     */
+    offWindowResize(
+      /** 窗口尺寸变化事件的回调函数 */
+      callback: offWindowResize.Callback,
+    ): void
   }
-  /** 取消监听窗口尺寸变化事件
-   * @supported weapp, h5
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/window/wx.offWindowResize.html
-   */
-  function offWindowResize(
-    /** 窗口尺寸变化事件的回调函数 */
-    callback: offWindowResize.Callback,
-  ): void
 }

package/types/api/worker/index.d.ts

@@ -1,31 +1,13 @@
-declare namespace Taro {
-  /** 创建一个 Worker 线程。目前限制最多只能创建一个 Worker，创建下一个 Worker 前请先调用 [Worker.terminate](https://developers.weixin.qq.com/miniprogram/dev/api/worker/Worker.terminate.html)
-   * @supported weapp
-   * @example
-   * ```tsx
-   * const worker = Taro.createWorker('workers/request/index.js') // 文件名指定 worker 的入口文件路径，绝对路径
-   *   worker.onMessage(function (res) {
-   *   console.log(res)
-   * })
-   * worker.postMessage({
-   *   msg: 'hello worker'
-   * })
-   * worker.terminate()
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/worker/wx.createWorker.html
-   */
-  function createWorker(
-    /** worker 入口文件的**绝对路径** */
-    scriptPath: string,
-  ): Worker
+import Taro from '../../index'
 
+declare module '../../index' {
   namespace Worker {
     type OnMessageCallback = (
       result: OnMessageCallbackResult,
     ) => void
     interface OnMessageCallbackResult {
       /** 主线程/Worker 线程向当前线程发送的消息 */
-      message: General.IAnyObject
+      message: TaroGeneral.IAnyObject
     }
   }
   interface Worker {
@@ -41,7 +23,7 @@ declare namespace Taro {
      * @supported weapp
      * @example
      * worker 线程中
-     * 
+     *
      * ```tsx
      * worker.postMessage({
      *   msg: 'hello from worker'
@@ -49,7 +31,7 @@ declare namespace Taro {
      * ```
      *
      * 主线程中
-     * 
+     *
      * ```tsx
      * const worker = Taro.createWorker('workers/request/index.js')
      * worker.postMessage({
@@ -60,7 +42,7 @@ declare namespace Taro {
      */
     postMessage(
       /** 需要发送的消息，必须是一个可序列化的 JavaScript key-value 形式的对象。 */
-      message: General.IAnyObject,
+      message: TaroGeneral.IAnyObject,
     ): void
     /** 结束当前 Worker 线程。仅限在主线程 worker 对象上调用。
      * @supported weapp
@@ -68,4 +50,26 @@ declare namespace Taro {
      */
     terminate(): void
   }
+
+  interface TaroStatic {
+    /** 创建一个 Worker 线程。目前限制最多只能创建一个 Worker，创建下一个 Worker 前请先调用 [Worker.terminate](https://developers.weixin.qq.com/miniprogram/dev/api/worker/Worker.terminate.html)
+     * @supported weapp
+     * @example
+     * ```tsx
+     * const worker = Taro.createWorker('workers/request/index.js') // 文件名指定 worker 的入口文件路径，绝对路径
+     *   worker.onMessage(function (res) {
+     *   console.log(res)
+     * })
+     * worker.postMessage({
+     *   msg: 'hello worker'
+     * })
+     * worker.terminate()
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/worker/wx.createWorker.html
+     */
+    createWorker(
+      /** worker 入口文件的**绝对路径** */
+      scriptPath: string,
+    ): Worker
+  }
 }

package/types/api/wxml/index.d.ts

@@ -1,35 +1,6 @@
-declare namespace Taro {
-  /** 返回一个 SelectorQuery 对象实例。在自定义组件或包含自定义组件的页面中，应使用 `this.createSelectorQuery()` 来代替。
-   * @supported weapp, h5
-   * @example
-   * ```tsx
-   * const query = Taro.createSelectorQuery()
-   * query.select('#the-id').boundingClientRect()
-   * query.selectViewport().scrollOffset()
-   * query.exec(function(res){
-   *   res[0].top       // #the-id节点的上边界坐标
-   *   res[1].scrollTop // 显示区域的竖直滚动位置
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/wxml/wx.createSelectorQuery.html
-   */
-  function createSelectorQuery(): SelectorQuery
-
-  /** 创建并返回一个 IntersectionObserver 对象实例。在自定义组件或包含自定义组件的页面中，应使用 `this.createIntersectionObserver([options])` 来代替。
-   * @supported weapp
-   * @example
-   * ```tsx
-   * const observer = Taro.createIntersectionObserver(this, { thresholds: [0], observeAll: true })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/wxml/wx.createSelectorQuery.html
-   */
-  function createIntersectionObserver(
-    /** 自定义组件实例 */
-    component: General.IAnyObject,
-    /** 选项 */
-    options?: createIntersectionObserver.Option,
-  ): IntersectionObserver
+import Taro from '../../index'
 
+declare module '../../index' {
   namespace createIntersectionObserver {
     /** 选项 */
     interface Option {
@@ -71,7 +42,7 @@ declare namespace Taro {
     /** 指定页面显示区域作为参照区域之一
      * @example
      * 下面的示例代码中，如果目标节点（用选择器 .target-class 指定）进入显示区域以下 100px 时，就会触发回调函数。
-     * 
+     *
      * ```tsx
      * Taro.createIntersectionObserver().relativeToViewport({bottom: 100}).observe('.target-class', (res) => {
      *   res.intersectionRatio // 相交区域占目标节点的布局区域的比例
@@ -269,7 +240,7 @@ declare namespace Taro {
      */
     in(
         /** 自定义组件实例 */
-        component: General.IAnyObject,
+        component: TaroGeneral.IAnyObject,
     ): SelectorQuery
   }
 
@@ -404,7 +375,7 @@ declare namespace Taro {
       /** 节点的下边界坐标 */
       bottom: number
       /** 节点的 dataset */
-      dataset: General.IAnyObject
+      dataset: TaroGeneral.IAnyObject
       /** 节点的高度 */
       height: number
       /** 节点的 ID */
@@ -422,7 +393,7 @@ declare namespace Taro {
     type ContextCallback = (result: ContextCallbackResult) => void
     interface ContextCallbackResult {
       /** 节点对应的 Context 对象 */
-      context: General.IAnyObject
+      context: TaroGeneral.IAnyObject
     }
 
     interface Fields {
@@ -450,20 +421,20 @@ declare namespace Taro {
     /** 回调函数 */
     type FieldsCallback = (
       /** 节点的相关信息 */
-      res: General.IAnyObject,
+      res: TaroGeneral.IAnyObject,
     ) => void
     /** 回调函数，在执行 `SelectorQuery.exec` 方法后，返回节点信息。 */
     type NodeCallback = (result: NodeCallbackResult) => void
     /** 回调函数 */
     interface NodeCallbackResult {
       /** 节点对应的 Node 实例 */
-      node: General.IAnyObject
+      node: TaroGeneral.IAnyObject
     }
     /** 回调函数，在执行 `SelectorQuery.exec` 方法后，节点信息会在 `callback` 中返回。 */
     type ScrollOffsetCallback = (result: ScrollOffsetCallbackResult) => void
     interface ScrollOffsetCallbackResult {
       /** 节点的 dataset */
-      dataset: General.IAnyObject
+      dataset: TaroGeneral.IAnyObject
       /** 节点的 ID */
       id: string
       /** 节点的水平滚动位置 */
@@ -472,4 +443,37 @@ declare namespace Taro {
       scrollTop: number
     }
   }
+
+  interface TaroStatic {
+    /** 返回一个 SelectorQuery 对象实例。在自定义组件或包含自定义组件的页面中，应使用 `this.createSelectorQuery()` 来代替。
+     * @supported weapp, h5
+     * @example
+     * ```tsx
+     * const query = Taro.createSelectorQuery()
+     * query.select('#the-id').boundingClientRect()
+     * query.selectViewport().scrollOffset()
+     * query.exec(function(res){
+     *   res[0].top       // #the-id节点的上边界坐标
+     *   res[1].scrollTop // 显示区域的竖直滚动位置
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/wxml/wx.createSelectorQuery.html
+     */
+    createSelectorQuery(): SelectorQuery
+
+    /** 创建并返回一个 IntersectionObserver 对象实例。在自定义组件或包含自定义组件的页面中，应使用 `this.createIntersectionObserver([options])` 来代替。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * const observer = Taro.createIntersectionObserver(this, { thresholds: [0], observeAll: true })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/wxml/wx.createSelectorQuery.html
+     */
+    createIntersectionObserver(
+      /** 自定义组件实例 */
+      component: TaroGeneral.IAnyObject,
+      /** 选项 */
+      options?: createIntersectionObserver.Option,
+    ): IntersectionObserver
+  }
 }

package/types/compile.d.ts

@@ -209,10 +209,6 @@ declare enum LogLevel {
   DEBUG = 'debug'
 }
 
-export interface IDeviceRatio {
-  [key: string]: number
-}
-
 export type SystemConfig = {
   /**
    * 打印日志等级，分为 off,error,warn,info,log,debug
@@ -361,7 +357,7 @@ export interface IProjectBaseConfig {
   date?: string,
   designWidth?: number,
   watcher?: any[],
-  deviceRatio?: IDeviceRatio,
+  deviceRatio?: TaroGeneral.TDeviceRatio,
   sourceRoot?: string,
   outputRoot?: string,
   env?: IOption,