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

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

@@ -21,9 +21,148 @@ declare module '../../index' {
     type MediaType = 'photo' | 'video'
   }
 
+  namespace getQQRunData {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /**
+       * 包括敏感数据在内的完整用户信息的加密数据，详细见加密数据解密算法。
+       */
+      encryptedData: string
+      /**
+       * 加密算法的初始向量，详细见加密数据解密算法
+       */
+      iv: string
+    }
+  }
+
+  namespace setOfficialDress {
+    interface Option {
+      /** 方法名，设置头像填"setAvatar"，其他方法后续开放 */
+      action: string
+      /** openid，给自己设置头像填"self" */
+      uin: string
+      /** 物品id */
+      item_id?: string
+      /** 设置头像"setAvatar"此处不用填 */
+      busi_info?: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace setCustomDress {
+    interface Option {
+      /** 方法名，设置头像填"uploadAvatar"，其他方法后续开放 */
+      action: string
+      /** 素材路径，必须为本地文件，路径为 wxfile:// 的形式 */
+      path: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace updateQQApp {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace addRecentColorSign {
+    interface Option {
+      /**
+       * 做为点击最近彩签打开的小程序页面的启动参数，如 a=1&b=2
+       * 默认值：当前页面的查询参数
+       */
+      query?: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace getGuildInfo {
+    interface Option {
+      /** 频道id */
+      open_guild_id: string
+      /** 子频道Id */
+      channel_id?: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult extends  TaroGeneral.CallbackResult {
+      /** 加密之后的数据，需要解密 */
+      encryptedData: string
+      /** 对称解密算法初始向量(base64) */
+      iv: string
+      /** 签名(base64) */
+      signature: string
+    }
+  }
+
+  namespace applyAddToMyApps {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult {
+      /** true 代表用户选择了同意 */
+      confirm: boolean
+      /** true 代表用户选择了不同意 */
+      cancel: boolean
+    }
+  }
+
+  namespace isAddedToMyApps {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult extends  TaroGeneral.CallbackResult {
+      /** true 代表用户已经添加，false 则还没添加 */
+      isAdded: boolean
+    }
+  }
+
   interface TaroStatic {
     /**
      * 此接口可打开手Q说说发表界面，并将文字内容和图片/视频内容传递到手Q说说发表界面。
+     * @supported qq
+     * @example
      * ```tsx
      * Taro.openQzonePublish({
      *   footnote: '使用同款滤镜',
@@ -41,9 +180,175 @@ declare module '../../index' {
      *   ]
      * })
      * ```
-     * @supported qq
      * @see https://q.qq.com/wiki/develop/miniprogram/API/open_port/port_openQzonePublish.html
      */
     openQzonePublish(option: openQzonePublish.Option): void
+    /**
+     * 获取用户过去三十天QQ运动步数。需要先调用 qq.login 接口。步数信息会在用户主动进入小程序时更新。
+     * @supported qq
+     * @example
+     * ```tsx
+     * Taro.getQQRunData({
+     *   success(res) {
+     *     // 拿 encryptedData 到开发者后台解密开放数据
+     *     const encryptedData = res.encryptedData
+     *   }
+     * })
+     * ```
+     *
+     * **开放数据 JSON 结构**
+     * 敏感数据有两种获取方式，一是使用 加密数据解密算法 。 获取得到的开放数据为以下 json 结构：
+     *
+     * ```json
+     * {
+     *   "stepInfoList": [
+     *     {
+     *       "timestamp": 1445866601,
+     *       "step": 100
+     *     },
+     *     {
+     *       "timestamp": 1445876601,
+     *       "step": 120
+     *     }
+     *   ]
+     * }
+     * ```
+     * * stepInfoList 中，每一项结构如下：
+     *
+     * | 属性 | 类型 | 说明 |
+     * | --- | ---- | --- |
+     * | timestamp | number | 时间戳，表示数据对应的时间 |
+     * | step | number | QQ运动步数 |
+     * 
+     * @see https://q.qq.com/wiki/develop/miniprogram/API/open_port/port_sport.html
+     */
+    getQQRunData(option: getQQRunData.Option): void
+    /**
+     * QQ美化平台内测阶段，仅被邀请的商户可使用此接口。
+     * @supported qq
+     * @example
+     * ```tsx
+     * Taro.setOfficialDress({
+     *   action: "setAvatar",
+     *   uin: "self",
+     *   item_id: "2740",
+     *   success(res) {
+     *     console.log("success"+res);
+     *   },
+     *   fail(res) {
+     *     console.log("fail"+res);
+     *   }
+     * })
+     * ```
+     * @see https://q.qq.com/wiki/develop/miniprogram/API/open_port/personalize.html#qq-setofficialdress
+     */
+    setOfficialDress(option: setOfficialDress.Option): void
+    /**
+     * QQ美化平台内测阶段，仅被邀请的商户可使用此接口。
+     * @supported qq
+     * @example
+     * ```tsx
+     * Taro.setCustomDress({
+     *   action: "uploadAvatar",
+     *   path:"wxfile://images/1.png"
+     *   success(res) {
+     *     console.log("success"+res);
+     *   },
+     *   fail(res) {
+     *     console.log("fail"+res);
+     *   }
+     * })
+     * ```
+     * @see https://q.qq.com/wiki/develop/miniprogram/API/open_port/personalize.html#qq-setcustomdress
+     */
+    setCustomDress(option: setCustomDress.Option): void
+    /**
+     * 更新 QQ 版本
+     * @supported qq
+     * @example
+     * ```tsx
+     * Taro.updateQQApp({
+     *   success: function(res) {
+     *     console.log('updateQQApp success',res)
+     *   },
+     *   fail: function(err) {
+     *     console.log('updateQQApp fail',err)
+     *   },
+     *   complete: function(res) {
+     *     console.log('updateQQApp info',res)
+     *   }
+     * })
+     * ```
+     * @see https://q.qq.com/wiki/develop/miniprogram/API/open_port/port_updateQQ.html#qq-updateqqapp
+     */
+    updateQQApp(option: updateQQApp.Option): void
+    /**
+     * 添加当前小程序页面到最近浏览彩签，需要授权基础库 1.20.0 开始支持。
+     * 提示：在手 Q 8.9.0 前的版本，当系统未授予手 Q 悬浮穿权限时，每次调用该接口都会弹出系统授权窗口。自手 Q 8.9.0 起交互调整如下:
+     *   1. 系统没有授予手 Q 悬浮窗权限时，接口执行 fail 回调函数并附带 ”No floating window permission“的错误信息，开发者可针对此信息在业务代码里弹窗提示用户手动授予手 Q 悬浮窗权限。
+     *   2. 安卓系统部分机型存在获取悬浮窗权限不准确情况。
+     * @supported qq
+     * @example
+     * ```tsx
+     * Taro.addRecentColorSign({
+     *   query: 'a=1&b=2',
+     *   success(res) {
+     *     console.log('addRecentColorSign success: ', res)
+     *   },
+     *   fail(err) {
+     *     console.log('addRecentColorSign fail: ', err)
+     *   },
+     *   complete(res) {
+     *     console.log('addRecentColorSign complete: ', res)
+     *   }
+     * })
+     * ```
+     * @see https://q.qq.com/wiki/develop/miniprogram/API/open_port/port_addColorSign.html#qq-addrecentcolorsign
+     */
+    addRecentColorSign(option: addRecentColorSign.Option): void
+    /**
+     * 获取频道信息与当前人身份（FOR 机器人服务入口）
+     * @supported qq
+     * @see https://q.qq.com/wiki/develop/miniprogram/API/open_port/port_guild.html
+     */
+    getGuildInfo(option: getGuildInfo.Option): void
+    /**
+     * 申请用户将本小程序添加到下拉页面中“我的小程序”当中，手Q8.9.13及以上版本支持
+     * @supported qq
+     * @example
+     * ```tsx
+     * Taro.applyAddToMyApps({
+     *   success(res) {
+     *     if (res.confirm) {
+     *       // 用户同意添加
+     *     }
+     *     if (res.cancel) {
+     *       // 用户不同意添加
+     *     }
+     *     // 原则上，confirm和cancel是互斥的
+     *   }
+     * })
+     * ```
+     * @see https://q.qq.com/wiki/develop/miniprogram/API/open_port/port_addToMyApps.html#qq-applyaddtomyapps
+     */
+    applyAddToMyApps(option: applyAddToMyApps.Option): void
+    /**
+     * 查询用户是否已经将本小程序添加到下拉页面中“我的小程序”当中，手Q8.9.13及以上版本支持，建议使用qq.applyAddToMyApps之前先调用qq.isAddedToMyApps来作前置判断
+     * @supported qq
+     * @example
+     * ```tsx
+     * Taro.isAddedToMyApps({
+     *   success(res) {
+     *     if (res.isAdded) {
+     *       // 用户已经添加
+     *     } else {
+     *       // 用户还未添加
+     *     }
+     *   }
+     * })
+     * ```
+     * @see https://q.qq.com/wiki/develop/miniprogram/API/open_port/port_addToMyApps.html#qq-isaddedtomyapps
+     */
+    isAddedToMyApps(option: isAddedToMyApps.Option): void
   }
 }

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

@@ -117,7 +117,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, h5, rn, tt, harmony, harmony_hybrid
      * @example
      * ```json
      * {
@@ -143,7 +143,7 @@ declare module '../../index' {
     switchTab(option: switchTab.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 关闭所有页面，打开到应用内的某个页面
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, h5, rn, tt, harmony, harmony_hybrid
      * @example
      * ```tsx
      * Taro.reLaunch({
@@ -155,7 +155,8 @@ declare module '../../index' {
     reLaunch(option: reLaunch.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 关闭当前页面，跳转到应用内的某个页面。但是不允许跳转到 tabbar 页面。
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, h5, rn, tt, harmony, harmony_hybrid
+     * @h5 未针对 tabbar 页面做限制处理
      * @example
      * ```tsx
      * Taro.redirectTo({
@@ -167,7 +168,8 @@ declare module '../../index' {
     redirectTo(option: redirectTo.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 保留当前页面，跳转到应用内的某个页面。但是不能跳到 tabbar 页面。使用 Taro.navigateBack 可以返回到原页面。小程序中页面栈最多十层。
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, h5, rn, tt, harmony, harmony_hybrid
+     * @h5 未针对 tabbar 页面做限制处理
      * @example
      * ```tsx
      * Taro.navigateTo({
@@ -193,7 +195,8 @@ declare module '../../index' {
     navigateTo(option: navigateTo.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 关闭当前页面，返回上一页面或多级页面。可通过 getCurrentPages 获取当前的页面栈，决定需要返回几层。
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, h5, rn, tt, harmony, harmony_hybrid
+     * @h5 若入参 delta 大于现有页面数时，返回应用打开的第一个页面（如果想要返回首页请使用 reLaunch 方法）。
      * @example
      * ```tsx
      * // 注意：调用 navigateTo 跳转时，调用该方法的页面会被加入堆栈，而 redirectTo 方法则不会。见下方示例代码

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

@@ -0,0 +1,59 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  /**
+   * Snapshot 实例，可通过 SelectorQuery 获取。
+   *
+   * Snapshot 通过 id 跟一个 snapshot 组件绑定，操作对应的 snapshot 组件。
+   * @supported weapp
+   * @see https://developers.weixin.qq.com/miniprogram/dev/api/skyline/Snapshot.html
+   */
+  interface Snapshot {
+    /**
+     * 画布宽度
+     */
+    width: number
+    /**
+     * 画布高度
+     */
+    height: number
+    /**
+     * 对 snapshot 组件子树进行截图
+     * @param option
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/skyline/Snapshot.takeSnapshot.html
+     */
+    takeSnapshot(option: Snapshot.TakeSnapshot.Option): Promise<TaroGeneral.CallbackResult>
+  }
+
+  namespace Snapshot {
+    namespace TakeSnapshot {
+      interface Option {
+        /**
+         * 截图导出类型，'file' 保存到临时文件目录或 'arraybuffer' 返回图片二进制数据，默认值为 'file'
+         */
+        type: string
+        /**
+         * 截图文件格式，'rgba' 或 'png'，默认值为 'png'
+         */
+        format: string
+        /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+        complete?: (res: TaroGeneral.CallbackResult) => void
+        /** 接口调用失败的回调函数 */
+        fail?: (res: TaroGeneral.CallbackResult) => void
+        /** 接口调用成功的回调函数 */
+        success?: (res: SuccessCallbackResult) => void
+      }
+
+      interface SuccessCallbackResult {
+        /**
+         * 截图保存的临时文件路径，当 type 为 file 该字段生效
+         */
+        tempFilePath: string
+        /**
+         * 截图对应的二进制数据，当 type 为 arraybuffer 该字段生效
+         */
+        data: string
+      }
+    }
+  }
+}

package/types/api/storage/background-fetch.d.ts

@@ -25,6 +25,25 @@ declare module '../../index' {
       /** 接口调用成功的回调函数 */
       success?: (res: TaroGeneral.CallbackResult) => void
     }
+
+    type Callback = (
+      result: CallbackResult,
+    ) => void
+
+    interface CallbackResult {
+      /** 缓存数据类别，取值为 periodic 或 pre */
+      fetchType: string
+      /** 缓存数据 */
+      fetchedData: string
+      /** 客户端拿到缓存数据的时间戳 */
+      timeStamp: number
+      /** 小程序页面路径 */
+      path: string
+      /** 传给页面的 query 参数 */
+      query: string
+      /** 进入小程序的场景值 */
+      scene: number
+    }
   }
 
   namespace getBackgroundFetchToken {
@@ -34,46 +53,79 @@ declare module '../../index' {
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
-      success?: (res: TaroGeneral.CallbackResult) => void
+      success?: (res: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 自定义的登录态 */
+      token: string
+      /** 接口调用结果 */
+      errMsg: string
     }
   }
 
   namespace getBackgroundFetchData {
     interface Option {
-      /** 取值为 periodic */
+      /** 缓存数据类别
+       * @weapp 取值为 periodic
+       * @qq 取值为 periodic
+       * @alipay 取值为 pre: 数据预拉取; jsapiPre: API 预调用（目前仅支持地理位置预拉取）
+       */
       fetchType: string
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
-      success?: (res: TaroGeneral.CallbackResult) => void
+      success?: (res: SuccessCallbackResult) => void
+    }
+
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 缓存数据
+       *  @alipay Object
+       */
+      fetchedData: string | Object
+      /** 客户端拿到缓存数据的时间戳 ms。(iOS 时间戳存在异常，8.0.27 修复) */
+      timeStamp: number
+      /** 小程序页面路径 */
+      path: string
+      /** 传给页面的 query 参数 */
+      query: string
+      /** 进入小程序的场景值 */
+      scene: number
+      /** 缓存数据类型，与入参 fetchType 一致
+       * @supported alipay
+       */
+      fetchType?: string
+      /** 缓存数据的时间戳。单位：ms。
+       * @supported alipay
+       */
+      timestamp?: number
     }
   }
 
   interface TaroStatic {
     /** 设置自定义登录态，在周期性拉取数据时带上，便于第三方服务器验证请求合法性
-     * @supported weapp
+     * @supported weapp, qq
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/background-fetch/wx.setBackgroundFetchToken.html
      */
-    setBackgroundFetchToken(option: setBackgroundFetchToken.Option): void
+    setBackgroundFetchToken(option: setBackgroundFetchToken.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 收到 backgroundFetch 数据时的回调
-     * @supported weapp
+     * @supported weapp, qq
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/background-fetch/wx.onBackgroundFetchData.html
      */
-    onBackgroundFetchData(option?: onBackgroundFetchData.Option): void
+    onBackgroundFetchData(option?: onBackgroundFetchData.Option | onBackgroundFetchData.Callback): void
 
     /** 获取设置过的自定义登录态。若无，则返回 fail。
-     * @supported weapp
+     * @supported weapp, qq
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/background-fetch/wx.getBackgroundFetchToken.html
      */
-    getBackgroundFetchToken(option?: getBackgroundFetchToken.Option): void
+    getBackgroundFetchToken(option?: getBackgroundFetchToken.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 拉取 backgroundFetch 客户端缓存数据
-     * @supported weapp
+     * @supported weapp, alipay, qq
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/background-fetch/wx.getBackgroundFetchData.html
      */
-    getBackgroundFetchData(option: getBackgroundFetchData.Option): void
+    getBackgroundFetchData(option: getBackgroundFetchData.Option): Promise<getBackgroundFetchData.SuccessCallbackResult>
   }
 }

package/types/api/storage/cache-manager.d.ts

@@ -2,8 +2,42 @@ import Taro from '../../index'
 
 declare module '../../index' {
   interface CacheManager {
+    /** 当前缓存模式 */
+    mode: keyof CacheManager.Mode
+    /** 全局 origin */
+    origin: string
+    /** 全局缓存有效时间 */
+    maxAge: number
+    /** 当前缓存管理器状态 */
+    state: keyof CacheManager.State
     /** 添加规则
      * @supported weapp
+     * @example
+     * ```tsx
+     * const ruleId = cacheManager.addRule({
+     *   id: 'haha-rule',
+     *   method: 'GET',
+     *   url: '/haha',
+     *   maxAge: 123455,
+     *   dataSchema: [
+     *     // data 字段的匹配，默认为空，表示不匹配
+     *     // 类型可以是：string、number、boolean、null、object、any（表示任意类型均可），以及这些类型的数组表示方式
+     *     {name: 'aaa', schema: {type: 'string'}}, // 类型为 string
+     *     {name: 'bbb', schema: [{type: 'number'}, {type: 'string'}]}, // 类型为 number, string
+     *     {name: 'ccc', schema: {type: 'string', value: 'abc'}}, // 值为 abc
+     *     {name: 'ddd', schema: {type: 'string', value: /(abc|cba)/ig}}, // 值符合该正则匹配，如果该值不是字符串类型，则会被尝试转成字符串后再进行比较
+     *     {name: 'ddd', schema: {type: 'string', value: val => val === '123'}}, // 传入函数来校验值
+     *     {name: 'eee', schema: {type: 'object', value: [{ // 类型为对象，则通过嵌套的方式来逐层校验
+     *       name: 'aaa', schema: {type: 'string'},
+     *       // ...
+     *       // 嵌套 dataSchema，同上面的方式一样来匹配嵌套的对象
+     *     }]}},
+     *     {name: 'fff', schema: {type: 'string[]'}}, // 类型为 string 数组
+     *     {name: 'ggg', schema: {type: 'any'}}, // 类型为任意类型
+     *     {name: 'hhh', schema: {type: 'any[]'}}, // 类型为任意类型的数组
+     *   ]
+     * })
+     * ```
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.addRule.html
      */
     addRule(option: CacheManager.AddRuleOption): string
@@ -26,7 +60,7 @@ declare module '../../index' {
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.deleteCache.html
      */
-    deleteCache( 
+    deleteCache(
       /** 缓存 id */
       id: string
     ): void
@@ -40,7 +74,7 @@ declare module '../../index' {
     ): void
     /** 删除规则，同时会删除对应规则下所有缓存
      * @supported weapp
-     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.deleteRule.html 
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.deleteRule.html
      */
     deleteRule(
       /** 规则 id */
@@ -67,17 +101,17 @@ declare module '../../index' {
       /** 事件名称 */
       eventName: string,
       /** 事件监听函数 */
-      handler: Function
+      handler: TaroGeneral.EventCallback
     ): void
     /** 监听事件
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.on.html
      */
-    on( 
+    on(
       /** 事件名称 */
       eventName: keyof CacheManager.OnEventName,
       /** 事件监听函数 */
-      handler: Function
+      handler: TaroGeneral.EventCallback
     ): void
     /** 开启缓存，仅在 mode 为 none 时生效，调用后缓存管理器的 state 会置为 1
      * @supported weapp
@@ -92,6 +126,22 @@ declare module '../../index' {
   }
 
   namespace CacheManager {
+    interface Mode {
+      /** 默认值，弱网/离线使用缓存返回 */
+      weakNetwork
+      /** 总是使用缓存返回 */
+      always
+      /** 不开启，后续可手动开启/停止使用缓存返回	*/
+      none
+    }
+    interface State {
+      /** 不使用缓存返回 */
+      0
+      /** 使用缓存返回 */
+      1
+      /** 未知 */
+      2
+    }
     interface DataSchema {
       /** 需要匹配的 data 对象的参数类型
        * string、number、boolean、null、object、any（表示任意类型），
@@ -117,7 +167,7 @@ declare module '../../index' {
       method: string
       /** uri 匹配规则，可参考规则字符串写法和正则写法 */
       url: any
-      /** 
+      /**
        * 缓存有效时间，单位为 ms，不填则默认取缓存管理器全局的缓存有效时间
        * @default 7 * 24 * 60 * 60 * 1000
        */
@@ -135,6 +185,7 @@ declare module '../../index' {
       rule: Rule
     }
     interface AddRulesOption {
+      /** 规则列表 */
       rules: Rule[]
     }
     interface MatchOption {
@@ -189,10 +240,10 @@ declare module '../../index' {
   }
 
   interface TaroStatic {
-    /** 拉起手机发送短信界面
-     * @supported weap
-     * @see declare module '../../index' 
+    /** 创建缓存管理器
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/wx.createCacheManager.html
      */
     createCacheManager(option: createCacheManager.Option): CacheManager
   }
-}
+}