@tarojs/taro 3.8.0-canary.0 → 4.0.0-beta.0

package/types/api/open-api/privacy.d.ts

@@ -0,0 +1,99 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace getPrivacySetting {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 是否需要用户授权隐私协议（如果开发者没有在[mp后台-设置-服务内容声明-用户隐私保护指引]中声明隐私收集类型则会返回false；如果开发者声明了隐私收集，且用户之前同意过隐私协议则会返回false；如果开发者声明了隐私收集，且用户还没同意过则返回true；如果用户之前同意过、但后来小程序又新增了隐私收集类型也会返回true） */
+      needAuthorization: boolean
+      /** 隐私授权协议的名称 */
+      privacyContractName: string
+    }
+  }
+
+  namespace requirePrivacyAuthorize {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace openPrivacyContract {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace onNeedPrivacyAuthorization {
+    /**
+     * resolve 是 onNeedPrivacyAuthorization 的回调参数，是一个接口函数。
+     * 当触发 needPrivacyAuthorization 事件时，触发该事件的隐私接口或组件会处于 pending 状态。
+     * 如果调用 resolve({ buttonId: 'disagree-btn'， event:'agree' })，则触发当前 needPrivacyAuthorization 事件的原隐私接口或组件会继续执行。其中 buttonId 为隐私同意授权按钮的id，为确保用户有同意的操作，基础库会检查对应的同意按钮是否被点击过。
+     * 如果调用 resolve({ event: 'disagree' })，则触发当前 needPrivacyAuthorization 事件的原隐私接口或组件会失败并返回 API:fail privacy permission is not authorized 的错误信息。
+     * 在调用 resolve({ event: 'agree'/'disagree' }) 之前，开发者可以调用 resolve({ event: 'exposureAuthorization' }) 把隐私弹窗曝光告知平台。
+     */
+    interface ResolveOption {
+      /** 用户操作类型 */
+      event: 'exposureAuthorization' | 'agree' | 'disagree'
+      /** 同意授权按钮的id （仅event=agree时必填） */
+      buttonId?: string
+    }
+    /**
+     * 触发本次 onNeedPrivacyAuthorization 事件的关联信息
+     */
+    interface EventInfo {
+      referrer: string
+    }
+
+    /** 隐私授权监听函数 */
+    type Listener = (
+      /** 事件回调函数 */
+      resolve: (option: ResolveOption) => void,
+      /** 关联事件信息 */
+      eventInfo: EventInfo
+    ) => void
+  }
+
+  interface TaroStatic {
+    /**
+     * 查询隐私授权情况。隐私合规开发指南详情可见《小程序隐私协议开发指南》
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/privacy/wx.getPrivacySetting.html
+     */
+    getPrivacySetting(option?: getPrivacySetting.Option): void
+    /**
+     * 跳转至隐私协议页面。隐私合规开发指南详情可见《小程序隐私协议开发指南》
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/privacy/wx.openPrivacyContract.html
+     */
+    openPrivacyContract(option?: openPrivacyContract.Option): void
+    /**
+     * 模拟隐私接口调用，并触发隐私弹窗逻辑。隐私合规开发指南详情可见《小程序隐私协议开发指南》
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/privacy/wx.requirePrivacyAuthorize.html
+     */
+    requirePrivacyAuthorize(option?: requirePrivacyAuthorize.Option): void
+    /**
+     * 监听隐私接口需要用户授权事件。当需要用户进行隐私授权时会触发。触发该事件时，开发者需要弹出隐私协议说明，并在用户同意或拒绝授权后调用回调接口 resolve 触发原隐私接口或组件继续执行。隐私合规开发指南详情可见《小程序隐私协议开发指南》
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/privacy/wx.onNeedPrivacyAuthorization.html
+     */
+    onNeedPrivacyAuthorization(listener: onNeedPrivacyAuthorization.Listener): 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
      * @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
      * @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
+     * @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
+     * @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
+     * @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
   }
-}
+}

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

@@ -49,6 +49,10 @@ declare module '../../index' {
       keys: string[]
       /** 限制的空间大小，单位 KB */
       limitSize: number
+      /** 是否执行成功
+       * @supported alipay
+       */
+      success?: boolean
     }
   }
 
@@ -102,9 +106,54 @@ declare module '../../index' {
     }
   }
 
+  namespace batchSetStorageSync {
+    interface Option {
+      /** [{ key, value }] */
+      kvList: kv[]
+    }
+    interface kv {
+      /** key 本地缓存中指定的 key */
+      key: string
+      /** data 需要存储的内容。只支持原生类型、Date、及能够通过JSON.stringify序列化的对象。*/
+      value: any
+    }
+  }
+
+  namespace batchSetStorage {
+    interface Option {
+      /** [{ key, value }] */
+      kvList: kv[]
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+    interface kv {
+      /** key 本地缓存中指定的 key */
+      key: string
+      /** data 需要存储的内容。只支持原生类型、Date、及能够通过JSON.stringify序列化的对象。*/
+      value: any
+    }
+  }
+
+  namespace batchGetStorage {
+    interface Option {
+      /** 本地缓存中指定的 keyList */
+      keyList: string[]
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
   interface TaroStatic {
     /** Taro.setStorage 的同步版本
-     * @supported weapp, h5, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5
      * @example
      * ```tsx
      * Taro.setStorage({
@@ -128,7 +177,7 @@ declare module '../../index' {
     ): void
 
     /** 将数据存储在本地缓存中指定的 key 中。会覆盖掉原来该 key 对应的内容。除非用户主动删除或因存储空间原因被系统清理，否则数据都一直可用。单个 key 允许存储的最大数据长度为 1MB，所有数据存储上限为 10MB。
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn, harmony
      * @example
      * ```tsx
      * Taro.setStorage({
@@ -155,7 +204,7 @@ declare module '../../index' {
     ): void
 
     /** Taro.removeStorage 的同步版本
-     * @supported weapp, h5, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5
      * @example
      * ```tsx
      * try {
@@ -172,7 +221,7 @@ declare module '../../index' {
     ): void
 
     /** 从本地缓存中移除指定 key
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn, harmony
      * @example
      * ```tsx
      * Taro.removeStorage({
@@ -187,7 +236,7 @@ declare module '../../index' {
     removeStorage(option: removeStorage.Option): Promise<TaroGeneral.CallbackResult>
 
     /** Taro.getStorage 的同步版本
-     * @supported weapp, h5, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5
      * @example
      * ```tsx
      * try {
@@ -207,7 +256,7 @@ declare module '../../index' {
     ): T
 
     /** Taro.getStorageInfo 的同步版本
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn
      * @example
      * ```tsx
      * try {
@@ -224,7 +273,7 @@ declare module '../../index' {
     getStorageInfoSync(): getStorageInfoSync.Option
 
     /** 异步获取当前storage的相关信息
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn
      * @example
      * ```tsx
      * Taro.getStorageInfo({
@@ -240,7 +289,7 @@ declare module '../../index' {
     getStorageInfo(option?: getStorageInfo.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 从本地缓存中异步获取指定 key 的内容
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn, harmony
      * @example
      * ```tsx
      * Taro.getStorage({
@@ -264,7 +313,7 @@ declare module '../../index' {
     ): void
 
     /** Taro.clearStorage 的同步版本
-     * @supported weapp, h5, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5
      * @example
      * ```tsx
      * try {
@@ -278,7 +327,7 @@ declare module '../../index' {
     clearStorageSync(): void
 
     /** 清理本地数据缓存
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn, harmony
      * @example
      * ```tsx
      * Taro.clearStorage()
@@ -286,5 +335,71 @@ declare module '../../index' {
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.clearStorage.html
      */
     clearStorage(option?: clearStorage.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 将数据批量存储在本地缓存中指定的 key 中。
+     * 会覆盖掉原来该 key 对应的内容。除非用户主动删除或因存储空间原因被系统清理，否则数据都一直可用。
+     * 单个 key 允许存储的最大数据长度为 1MB，所有数据存储上限为 10MB。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * try {
+     *   Taro.batchSetStorageSync([{key: 'key', value: 'value'}])
+     * } catch (e) { }
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.batchGetStorageSync.html
+     */
+    batchSetStorageSync(option: batchSetStorageSync.Option): void
+
+    /** 将数据批量存储在本地缓存中指定的 key 中。会覆盖掉原来该 key 对应的内容。
+     * 除非用户主动删除或因存储空间原因被系统清理，否则数据都一直可用。
+     * 单个 key 允许存储的最大数据长度为 1MB，所有数据存储上限为 10MB。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.batchGetStorage({
+     *   keyList: ['key']
+     *   success(res) {
+     *     console.log(res)
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.batchGetStorage.html
+     */
+    batchSetStorage(option: batchSetStorage.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 从本地缓存中同步批量获取指定 key 的内容。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * try {
+     *   var valueList = Taro.batchGetStorageSync(['key'])
+     *   if (valueList) {
+     *     // Do something with return value
+     *   }
+     * } catch (e) {
+     *   // Do something when catch error
+     * }
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.batchGetStorageSync.html
+     */
+    batchGetStorageSync<T = any>(
+      /** 本地缓存中指定的 key 数组 */
+      keyList: string[]
+    ): T[]
+
+    /** 从本地缓存中异步批量获取指定 key 的内容。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.batchGetStorage({
+     *   keyList: ['key'],
+     *   success(res) {
+     *     console.log(res)
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.batchGetStorage.html
+     */
+    batchGetStorage(option: batchGetStorage.Option): Promise<TaroGeneral.CallbackResult>
   }
 }