@tarojs/taro 3.3.12 → 3.4.0-beta.0

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

@@ -1,28 +1,6 @@
-declare namespace Taro {
-  /** Taro.setStorage 的同步版本
-   * @supported weapp, h5
-   * @example
-   * ```tsx
-   * Taro.setStorage({
-   *   key:"key",
-   *   data:"value"
-   * })
-   * ```
-   * @example
-   * ```tsx
-   * try {
-   *   Taro.setStorageSync('key', 'value')
-   * } catch (e) { }
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.setStorageSync.html
-   */
-  function setStorageSync(
-    /** 本地缓存中指定的 key */
-    key: string,
-    /** 需要存储的内容。只支持原生类型、Date、及能够通过`JSON.stringify`序列化的对象。 */
-    data: any,
-  ): void
+import Taro from '../../index'
 
+declare module '../../index' {
   namespace setStorage {
     interface Option {
       /** 需要存储的内容。只支持原生类型、Date、及能够通过`JSON.stringify`序列化的对象。 */
@@ -30,135 +8,26 @@ declare namespace Taro {
       /** 本地缓存中指定的 key */
       key: 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
     }
   }
 
-  /** 将数据存储在本地缓存中指定的 key 中。会覆盖掉原来该 key 对应的内容。除非用户主动删除或因存储空间原因被系统清理，否则数据都一直可用。单个 key 允许存储的最大数据长度为 1MB，所有数据存储上限为 10MB。
-   * @supported weapp, h5, rn
-   * @example
-   * ```tsx
-   * Taro.setStorage({
-   *   key:"key",
-   *   data:"value"
-   * })
-   * ```
-   * ```tsx
-   * try {
-   *   Taro.setStorageSync('key', 'value')
-   * } catch (e) { }
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.setStorage.html
-   */
-  function setStorage(option: setStorage.Option): Promise<General.CallbackResult>
-
-  /**
-   * 从本地缓存中同步移除指定 key 。
-   * @supported weapp, h5
-   * @example
-   * ```tsx
-   * try {
-   *   Taro.removeStorageSync('key')
-   * } catch (e) {
-   *   // Do something when catch error
-   * }
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.removeStorageSync.html
-   */
-  function removeStorageSync(key: string): void
-
-  /** Taro.removeStorage 的同步版本
-   * @example
-   * ```tsx
-   * Taro.removeStorage({
-   *   key: 'key',
-   *   success: function (res) {
-   *     console.log(res)
-   *   }
-   * })
-   * ```
-   *
-   * ```tsx
-   * try {
-   *   Taro.removeStorageSync('key')
-   * } catch (e) {
-   *   // Do something when catch error
-   * }
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.removeStorageSync.html
-   */
-  function removeStorageSync(
-    /** 本地缓存中指定的 key */
-    key: string,
-  ): void
-
   namespace removeStorage {
     interface Option {
       /** 本地缓存中指定的 key */
       key: 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
     }
   }
-  /** 从本地缓存中移除指定 key
-   * @supported weapp, h5, rn
-   * @example
-   * ```tsx
-   * Taro.removeStorage({
-   *   key: 'key',
-   *   success: function (res) {
-   *     console.log(res)
-   *   }
-   * })
-   * ```
-   *
-   * ```tsx
-   * try {
-   *   Taro.removeStorageSync('key')
-   * } catch (e) {
-   *   // Do something when catch error
-   * }
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.removeStorage.html
-   */
-  function removeStorage(option: removeStorage.Option): Promise<General.CallbackResult>
-
-  /** Taro.getStorage 的同步版本
-   * @supported weapp, h5
-   * @example
-   * ```tsx
-   * Taro.getStorage({
-   *   key: 'key',
-   *   success: function (res) {
-   *     console.log(res.data)
-   *   }
-   * })
-   * ```
-   *
-   * ```tsx
-   * try {
-   *   var value = Taro.getStorageSync('key')
-   *   if (value) {
-   *     // Do something with return value
-   *   }
-   * } catch (e) {
-   *   // Do something when catch error
-   * }
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.getStorageSync.html
-   */
-  function getStorageSync<T = any>(
-    /** 本地缓存中指定的 key */
-    key: string,
-  ): T
 
   namespace getStorageInfoSync {
     interface Option {
@@ -171,39 +40,12 @@ declare namespace Taro {
     }
   }
 
-  /** Taro.getStorageInfo 的同步版本
-   * @supported weapp, h5
-   * @example
-   * ```tsx
-   * Taro.getStorageInfo({
-   *   success: function (res) {
-   *     console.log(res.keys)
-   *     console.log(res.currentSize)
-   *     console.log(res.limitSize)
-   *   }
-   * })
-   * ```
-   *
-   * ```tsx
-   * try {
-   *   const res = Taro.getStorageInfoSync()
-   *   console.log(res.keys)
-   *   console.log(res.currentSize)
-   *   console.log(res.limitSize)
-   * } catch (e) {
-   *   // Do something when catch error
-   * }
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.getStorageInfoSync.html
-   */
-  function getStorageInfoSync(): getStorageInfoSync.Option
-
   namespace getStorageInfo {
     interface Option {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
       success?: (option: SuccessCallbackOption) => void
     }
@@ -218,45 +60,18 @@ declare namespace Taro {
     }
   }
 
-  /** 异步获取当前storage的相关信息
-   * @supported weapp, h5, rn
-   * @example
-   * ```tsx
-   * Taro.getStorageInfo({
-   *   success: function (res) {
-   *     console.log(res.keys)
-   *     console.log(res.currentSize)
-   *     console.log(res.limitSize)
-   *   }
-   * })
-   * ```
-   *
-   * ```tsx
-   * try {
-   *   const res = Taro.getStorageInfoSync()
-   *   console.log(res.keys)
-   *   console.log(res.currentSize)
-   *   console.log(res.limitSize)
-   * } catch (e) {
-   *   // Do something when catch error
-   * }
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.getStorageInfo.html
-   */
-  function getStorageInfo(option?: getStorageInfo.Option): Promise<General.CallbackResult>
-
   namespace getStorage {
     interface Option<T> {
       /** 本地缓存中指定的 key */
       key: string
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult<T>) => void
     }
-    interface SuccessCallbackResult<T> extends General.CallbackResult {
+    interface SuccessCallbackResult<T> extends TaroGeneral.CallbackResult {
       /** key对应的内容 */
       data: T
       /** 调用结果 */
@@ -264,76 +79,266 @@ declare namespace Taro {
     }
   }
 
-  /** 从本地缓存中异步获取指定 key 的内容
-   * @supported weapp, h5, rn
-   * @example
-   * ```tsx
-   * Taro.getStorage({
-   *   key: 'key',
-   *   success: function (res) {
-   *     console.log(res.data)
-   *   }
-   * })
-   * ```
-   *
-   * ```tsx
-   * try {
-   *   var value = Taro.getStorageSync('key')
-   *   if (value) {
-   *     // Do something with return value
-   *   }
-   * } catch (e) {
-   *   // Do something when catch error
-   * }
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.getStorage.html
-   */
-  function getStorage<T = any>(option: getStorage.Option<T>): Promise<getStorage.SuccessCallbackResult<T>>
-
-  /** Taro.clearStorage 的同步版本
-   * @supported weapp, h5
-   * @example
-   * ```tsx
-   * Taro.clearStorage()
-   * ```
-   *
-   * ```tsx
-   * try {
-   *   Taro.clearStorageSync()
-   * } catch(e) {
-   * // Do something when catch error
-   * }
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.clearStorageSync.html
-   */
-  function clearStorageSync(): void
-
   namespace clearStorage {
     interface Option {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      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, h5, rn
-   * @example
-   * ```tsx
-   * Taro.clearStorage()
-   * ```
-   *
-   * ```tsx
-   * try {
-   *   Taro.clearStorageSync()
-   * } catch(e) {
-   *   // Do something when catch error
-   * }
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.clearStorage.html
-   */
-  function clearStorage(option?: clearStorage.Option): Promise<General.CallbackResult>
+  interface TaroStatic {
+    /** Taro.setStorage 的同步版本
+     * @supported weapp, h5
+     * @example
+     * ```tsx
+     * Taro.setStorage({
+     *   key:"key",
+     *   data:"value"
+     * })
+     * ```
+     * @example
+     * ```tsx
+     * try {
+     *   Taro.setStorageSync('key', 'value')
+     * } catch (e) { }
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.setStorageSync.html
+     */
+    setStorageSync(
+      /** 本地缓存中指定的 key */
+      key: string,
+      /** 需要存储的内容。只支持原生类型、Date、及能够通过`JSON.stringify`序列化的对象。 */
+      data: any,
+    ): void
+
+    /** 将数据存储在本地缓存中指定的 key 中。会覆盖掉原来该 key 对应的内容。除非用户主动删除或因存储空间原因被系统清理，否则数据都一直可用。单个 key 允许存储的最大数据长度为 1MB，所有数据存储上限为 10MB。
+     * @supported weapp, h5, rn
+     * @example
+     * ```tsx
+     * Taro.setStorage({
+     *   key:"key",
+     *   data:"value"
+     * })
+     * ```
+     * ```tsx
+     * try {
+     *   Taro.setStorageSync('key', 'value')
+     * } catch (e) { }
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.setStorage.html
+     */
+    setStorage(option: setStorage.Option): Promise<TaroGeneral.CallbackResult>
+
+    /**
+     * 从本地缓存中同步移除指定 key 。
+     * @supported weapp, h5
+     * @example
+     * ```tsx
+     * try {
+     *   Taro.removeStorageSync('key')
+     * } catch (e) {
+     *   // Do something when catch error
+     * }
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.removeStorageSync.html
+     */
+    removeStorageSync(key: string): void
+
+    /** Taro.removeStorage 的同步版本
+     * @example
+     * ```tsx
+     * Taro.removeStorage({
+     *   key: 'key',
+     *   success: function (res) {
+     *     console.log(res)
+     *   }
+     * })
+     * ```
+     *
+     * ```tsx
+     * try {
+     *   Taro.removeStorageSync('key')
+     * } catch (e) {
+     *   // Do something when catch error
+     * }
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.removeStorageSync.html
+     */
+    removeStorageSync(
+      /** 本地缓存中指定的 key */
+      key: string,
+    ): void
+
+    /** 从本地缓存中移除指定 key
+     * @supported weapp, h5, rn
+     * @example
+     * ```tsx
+     * Taro.removeStorage({
+     *   key: 'key',
+     *   success: function (res) {
+     *     console.log(res)
+     *   }
+     * })
+     * ```
+     *
+     * ```tsx
+     * try {
+     *   Taro.removeStorageSync('key')
+     * } catch (e) {
+     *   // Do something when catch error
+     * }
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.removeStorage.html
+     */
+    removeStorage(option: removeStorage.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** Taro.getStorage 的同步版本
+     * @supported weapp, h5
+     * @example
+     * ```tsx
+     * Taro.getStorage({
+     *   key: 'key',
+     *   success: function (res) {
+     *     console.log(res.data)
+     *   }
+     * })
+     * ```
+     *
+     * ```tsx
+     * try {
+     *   var value = Taro.getStorageSync('key')
+     *   if (value) {
+     *     // Do something with return value
+     *   }
+     * } catch (e) {
+     *   // Do something when catch error
+     * }
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.getStorageSync.html
+     */
+    getStorageSync<T = any>(
+      /** 本地缓存中指定的 key */
+      key: string,
+    ): T
+
+    /** Taro.getStorageInfo 的同步版本
+     * @supported weapp, h5
+     * @example
+     * ```tsx
+     * Taro.getStorageInfo({
+     *   success: function (res) {
+     *     console.log(res.keys)
+     *     console.log(res.currentSize)
+     *     console.log(res.limitSize)
+     *   }
+     * })
+     * ```
+     *
+     * ```tsx
+     * try {
+     *   const res = Taro.getStorageInfoSync()
+     *   console.log(res.keys)
+     *   console.log(res.currentSize)
+     *   console.log(res.limitSize)
+     * } catch (e) {
+     *   // Do something when catch error
+     * }
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.getStorageInfoSync.html
+     */
+    getStorageInfoSync(): getStorageInfoSync.Option
+
+    /** 异步获取当前storage的相关信息
+     * @supported weapp, h5, rn
+     * @example
+     * ```tsx
+     * Taro.getStorageInfo({
+     *   success: function (res) {
+     *     console.log(res.keys)
+     *     console.log(res.currentSize)
+     *     console.log(res.limitSize)
+     *   }
+     * })
+     * ```
+     *
+     * ```tsx
+     * try {
+     *   const res = Taro.getStorageInfoSync()
+     *   console.log(res.keys)
+     *   console.log(res.currentSize)
+     *   console.log(res.limitSize)
+     * } catch (e) {
+     *   // Do something when catch error
+     * }
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.getStorageInfo.html
+     */
+    getStorageInfo(option?: getStorageInfo.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 从本地缓存中异步获取指定 key 的内容
+     * @supported weapp, h5, rn
+     * @example
+     * ```tsx
+     * Taro.getStorage({
+     *   key: 'key',
+     *   success: function (res) {
+     *     console.log(res.data)
+     *   }
+     * })
+     * ```
+     *
+     * ```tsx
+     * try {
+     *   var value = Taro.getStorageSync('key')
+     *   if (value) {
+     *     // Do something with return value
+     *   }
+     * } catch (e) {
+     *   // Do something when catch error
+     * }
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.getStorage.html
+     */
+    getStorage<T = any>(option: getStorage.Option<T>): Promise<getStorage.SuccessCallbackResult<T>>
+
+    /** Taro.clearStorage 的同步版本
+     * @supported weapp, h5
+     * @example
+     * ```tsx
+     * Taro.clearStorage()
+     * ```
+     *
+     * ```tsx
+     * try {
+     *   Taro.clearStorageSync()
+     * } catch(e) {
+     * // Do something when catch error
+     * }
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.clearStorageSync.html
+     */
+    clearStorageSync(): void
+
+    /** 清理本地数据缓存
+     * @supported weapp, h5, rn
+     * @example
+     * ```tsx
+     * Taro.clearStorage()
+     * ```
+     *
+     * ```tsx
+     * try {
+     *   Taro.clearStorageSync()
+     * } catch(e) {
+     *   // Do something when catch error
+     * }
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.clearStorage.html
+     */
+    clearStorage(option?: clearStorage.Option): Promise<TaroGeneral.CallbackResult>
+  }
 }

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

@@ -1,4 +1,6 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace setPageInfo {
     interface Option {
       /** 页面标题 */
@@ -51,45 +53,48 @@ declare namespace Taro {
       sessionDuration?: string
     }
   }
-  /**
-   * 百度智能小程序可接入百度搜索和百度 App，setPageInfo 负责为小程序设置各类页面基础信息，包括标题、关键字、页面描述以及图片信息、视频信息等。开发者为智能小程序设置完备的页面基础信息，有助于智能小程序在搜索引擎和信息流中得到更加有效的展示和分发。
-   * @supported swan
-   * @example
-   * ```tsx
-   * Taro.setPageInfo({
-   *   title: '晒元宵节活动红包，爱奇艺60张年卡、600张季卡等你拿！-百度贴吧',
-   *   keywords: '百度,百度贴吧,好运中国年,60,晒元,宵节',
-   *   description: '晒元宵节活动红包，爱..昨天的百度APP元宵节活动中，共发出2亿现金红包、含151万个手气现金大奖和240辆红旗轿车，谁是好运锦鲤，快来分享！马上惊喜升级~摇中红包的锦鲤们即刻晒出红包金额截图，我们将会抽取660位好运锦鲤',
-   *   articleTitle: '晒元宵节活动红包，爱奇艺60张年卡、600张季卡等你拿！',
-   *   releaseDate: '2019-01-02 12:01:30',
-   *   image: [
-   *       'http://c.hiphotos.baidu.com/forum/w%3D480/sign=73c62dda83b1cb133e693d1bed5456da/f33725109313b07e8dee163d02d7912396dd8cfe.jpg',
-   *       'https://hiphotos.baidu.com/fex/%70%69%63/item/43a7d933c895d143e7b745607ef082025baf07ab.jpg'
-   *   ],
-   *   video: [{
-   *       url: 'https://www.baidu.com/mx/v12.mp4',
-   *       duration: '100',
-   *       image: 'https://smartprogram.baidu.com/docs/img/image-scaleToFill.png'
-   *   }],
-   *   visit: {
-   *       pv: '1000',
-   *       uv: '100',
-   *       sessionDuration: '130'
-   *   },
-   *   likes: '75',
-   *   comments: '13',
-   *   collects: '23',
-   *   shares: '8',
-   *   followers: '35',
-   *   success: res => {
-   *       console.log('setPageInfo success');
-   *   },
-   *   fail: err => {
-   *       console.log('setPageInfo fail', err);
-   *   }
-   * })
-   * ```
-   * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-setPageInfo/
-   */
-  function setPageInfo(option: setPageInfo.Option): void
+
+  interface TaroStatic {
+    /**
+     * 百度智能小程序可接入百度搜索和百度 App，setPageInfo 负责为小程序设置各类页面基础信息，包括标题、关键字、页面描述以及图片信息、视频信息等。开发者为智能小程序设置完备的页面基础信息，有助于智能小程序在搜索引擎和信息流中得到更加有效的展示和分发。
+     * @supported swan
+     * @example
+     * ```tsx
+     * Taro.setPageInfo({
+     *   title: '晒元宵节活动红包，爱奇艺60张年卡、600张季卡等你拿！-百度贴吧',
+     *   keywords: '百度,百度贴吧,好运中国年,60,晒元,宵节',
+     *   description: '晒元宵节活动红包，爱..昨天的百度APP元宵节活动中，共发出2亿现金红包、含151万个手气现金大奖和240辆红旗轿车，谁是好运锦鲤，快来分享！马上惊喜升级~摇中红包的锦鲤们即刻晒出红包金额截图，我们将会抽取660位好运锦鲤',
+     *   articleTitle: '晒元宵节活动红包，爱奇艺60张年卡、600张季卡等你拿！',
+     *   releaseDate: '2019-01-02 12:01:30',
+     *   image: [
+     *       'http://c.hiphotos.baidu.com/forum/w%3D480/sign=73c62dda83b1cb133e693d1bed5456da/f33725109313b07e8dee163d02d7912396dd8cfe.jpg',
+     *       'https://hiphotos.baidu.com/fex/%70%69%63/item/43a7d933c895d143e7b745607ef082025baf07ab.jpg'
+     *   ],
+     *   video: [{
+     *       url: 'https://www.baidu.com/mx/v12.mp4',
+     *       duration: '100',
+     *       image: 'https://smartprogram.baidu.com/docs/img/image-scaleToFill.png'
+     *   }],
+     *   visit: {
+     *       pv: '1000',
+     *       uv: '100',
+     *       sessionDuration: '130'
+     *   },
+     *   likes: '75',
+     *   comments: '13',
+     *   collects: '23',
+     *   shares: '8',
+     *   followers: '35',
+     *   success: res => {
+     *       console.log('setPageInfo success');
+     *   },
+     *   fail: err => {
+     *       console.log('setPageInfo fail', err);
+     *   }
+     * })
+     * ```
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-setPageInfo/
+     */
+    setPageInfo(option: setPageInfo.Option): void
+  }
 }