@tarojs/taro 3.5.0-beta.0 → 3.5.0-beta.1

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

@@ -105,7 +105,7 @@ declare module '../../index' {
      * **关于调试**
      * - 在开发者工具上调用此 API 并不会真实的跳转到另外的小程序，但是开发者工具会校验本次调用跳转是否成功。[详情](https://developers.weixin.qq.com/miniprogram/dev/devtools/different.html#跳转小程序调试支持)
      * - 开发者工具上支持被跳转的小程序处理接收参数的调试。[详情](https://developers.weixin.qq.com/miniprogram/dev/devtools/different.html#跳转小程序调试支持)
-     * @supported weapp
+     * @supported weapp, tt
      * @example
      * ```tsx
      * Taro.navigateToMiniProgram({
@@ -127,7 +127,7 @@ declare module '../../index' {
     /** 返回到上一个小程序。只有在当前小程序是被其他小程序打开时可以调用成功
      *
      * 注意：**微信客户端 iOS 6.5.9，Android 6.5.10 及以上版本支持**
-     * @supported weapp
+     * @supported weapp, tt
      * @example
      * ```tsx
      * Taro.navigateBackMiniProgram({

package/types/api/network/download.d.ts

@@ -67,7 +67,7 @@ declare module '../../index' {
   }
 
   /** 一个可以监听下载进度变化事件，以及取消下载任务的对象
-   * @supported weapp, swan, alipay, h5, rn
+   * @supported weapp, swan, alipay, h5, rn, tt
    * @example
    * ```tsx
    * const downloadTask = Taro.downloadFile({
@@ -91,12 +91,12 @@ declare module '../../index' {
    */
   interface DownloadTask {
     /** 中断下载任务
-     * @supported weapp, h5, rn
+     * @supported weapp, h5, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/download/DownloadTask.abort.html
      */
     abort(): void
     /** 监听下载进度变化事件
-     * @supported weapp, h5, rn
+     * @supported weapp, h5, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/download/DownloadTask.onProgressUpdate.html
      */
     onProgressUpdate(
@@ -104,7 +104,7 @@ declare module '../../index' {
       callback: DownloadTask.OnProgressUpdateCallback,
     ): void
     /** 取消监听下载进度变化事件
-     * @supported weapp, h5, rn
+     * @supported weapp, h5, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/download/DownloadTask.offProgressUpdate.html
      */
     offProgressUpdate(
@@ -133,7 +133,7 @@ declare module '../../index' {
     /** 下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求，返回文件的本地临时路径，单次下载允许的最大文件为 50MB。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/network.html)。
      *
      * 注意：请在服务端响应的 header 中指定合理的 `Content-Type` 字段，以保证客户端正确处理文件类型。
-     * @supported weapp, h5, alipay, swan, rn
+     * @supported weapp, h5, alipay, swan, rn, tt
      * @example
      * ```tsx
      * Taro.downloadFile({

package/types/api/network/request.d.ts

@@ -14,7 +14,7 @@ declare module '../../index' {
       header?: TaroGeneral.IAnyObject
       /** 超时时间，单位为毫秒
        * @default 2000
-       * @supported weapp, h5
+       * @supported weapp, h5, tt
        */
       timeout?: number
       /** HTTP 请求方法
@@ -37,7 +37,7 @@ declare module '../../index' {
       enableQuic?: boolean
       /** 开启 cache
        * @default false
-       * @supported weapp
+       * @supported weapp, tt
        */
       enableCache?: boolean
       /** 是否开启 HttpDNS 服务。如开启，需要同时填入 httpDNSServiceId 。 HttpDNS 用法详见 移动解析HttpDNS
@@ -254,7 +254,7 @@ declare module '../../index' {
    */
   interface RequestTask<T> extends Promise<request.SuccessCallbackResult<T>> {
     /** 中断请求任务
-     * @supported weapp
+     * @supported weapp, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/request/RequestTask.abort.html
      */
     abort(): void

package/types/api/network/upload.d.ts

@@ -76,7 +76,7 @@ declare module '../../index' {
   }
 
   /** 一个可以监听上传进度变化事件，以及取消上传任务的对象
-   * @supported weapp, swan, alipay, h5, rn
+   * @supported weapp, swan, alipay, h5, rn, tt
    * @example
    * ```tsx
    * const uploadTask = Taro.uploadFile({
@@ -104,12 +104,12 @@ declare module '../../index' {
    */
   interface UploadTask {
     /** 中断上传任务
-     * @supported weapp, h5
+     * @supported weapp, h5, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/upload/UploadTask.abort.html
      */
     abort(): void
     /** 监听上传进度变化事件
-     * @supported weapp, h5
+     * @supported weapp, h5, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/upload/UploadTask.onProgressUpdate.html
      */
     onProgressUpdate(
@@ -117,7 +117,7 @@ declare module '../../index' {
       callback: UploadTask.OnProgressUpdateCallback,
     ): void
     /** 取消监听上传进度变化事件
-     * @supported weapp, h5
+     * @supported weapp, h5, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/upload/UploadTask.offProgressUpdate.html
      */
     offProgressUpdate(
@@ -144,7 +144,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求，其中 `content-type` 为 `multipart/form-data`。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/network.html)。
-     * @supported weapp, swan, alipay, h5, rn
+     * @supported weapp, swan, alipay, h5, rn, tt
      * @example
      * ```tsx
      * Taro.chooseImage({

package/types/api/network/websocket.d.ts

@@ -143,17 +143,17 @@ declare module '../../index' {
    */
   interface SocketTask {
     /** 通过 WebSocket 连接发送数据
-     * @supported weapp, h5, rn, alipay, swan
+     * @supported weapp, h5, rn, alipay, swan, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.send.html
      */
     send(option: SocketTask.SendOption): void
     /** 关闭 WebSocket 连接
-     * @supported weapp, h5, rn, alipay, swan
+     * @supported weapp, h5, rn, alipay, swan, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.close.html
      */
     close(option: SocketTask.CloseOption): void
     /** 监听 WebSocket 连接打开事件
-     * @supported weapp, h5, rn, alipay, swan
+     * @supported weapp, h5, rn, alipay, swan, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.onOpen.html
      */
     onOpen(
@@ -161,7 +161,7 @@ declare module '../../index' {
       callback: SocketTask.OnOpenCallback
     ): void
     /** 监听 WebSocket 连接关闭事件
-     * @supported weapp, h5, rn, alipay, swan
+     * @supported weapp, h5, rn, alipay, swan, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.onClose.html
      */
     onClose(
@@ -169,7 +169,7 @@ declare module '../../index' {
       callback: SocketTask.OnCloseCallback
     ): void
     /** 监听 WebSocket 错误事件
-     * @supported weapp, h5, rn, alipay, swan
+     * @supported weapp, h5, rn, alipay, swan, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.onError.html
      */
     onError(
@@ -177,7 +177,7 @@ declare module '../../index' {
       callback: SocketTask.OnErrorCallback
     ): void
     /** 监听 WebSocket 接受到服务器的消息事件
-     * @supported weapp, h5, rn, alipay, swan
+     * @supported weapp, h5, rn, alipay, swan, tt
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.onMessage.html
      */
     onMessage<T = any>(

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

@@ -35,7 +35,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 获取用户收货地址。调起用户编辑收货地址原生界面，并在编辑完成后返回用户选择的地址。
-     * @supported weapp
+     * @supported weapp, tt
      * @example
      * ```tsx
      * Taro.chooseAddress({

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

@@ -55,7 +55,7 @@ declare module '../../index' {
      authorizeForMiniProgram(option: authorizeForMiniProgram.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 提前向用户发起授权请求。调用后会立刻弹窗询问用户是否同意授权小程序使用某项功能或获取用户的某些数据，但不会实际调用对应接口。如果用户之前已经同意授权，则不会出现弹窗，直接返回成功。更多用法详见 [用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html)。
-     * @supported weapp
+     * @supported weapp, rn, tt
      * @example
      * ```tsx
      * // 可以通过 Taro.getSetting 先查询一下用户是否授权了 "scope.record" 这个 scope

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

@@ -135,7 +135,7 @@ declare module '../../index' {
     /** 调起客户端小程序设置界面，返回用户设置的操作结果。**设置界面只会出现小程序已经向用户请求过的[权限](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html)**。
      *
      * 注意：[2.3.0](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 版本开始，用户发生点击行为后，才可以跳转打开设置页，管理授权信息。[详情](https://developers.weixin.qq.com/community/develop/doc/000cea2305cc5047af5733de751008)
-     * @supported weapp
+     * @supported weapp, rn, tt
      * @example
      * ```tsx
      * Taro.openSetting({
@@ -153,7 +153,7 @@ declare module '../../index' {
     openSetting(option?: openSetting.Option): Promise<openSetting.SuccessCallbackResult>
 
     /** 获取用户的当前设置。**返回值中只会出现小程序已经向用户请求过的[权限](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html)**。
-     * @supported weapp
+     * @supported weapp, rn, tt
      * @example
      * ```tsx
      * Taro.getSetting({

package/types/api/open-api/subscribe-message.d.ts

@@ -118,7 +118,7 @@ declare module '../../index' {
     /** 请求订阅消息
      *
      * 注意：[2.8.2](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 版本开始，用户发生点击行为或者发起支付回调后，才可以调起订阅消息界面。
-     * @supported weapp
+     * @supported weapp, tt
      * @example
      * ```tsx
      * Taro.requestSubscribeMessage({
@@ -133,7 +133,7 @@ declare module '../../index' {
     ): Promise<requestSubscribeMessage.SuccessCallbackResult | requestSubscribeMessage.FailCallbackResult>
 
     /** 订阅设备消息接口，调用后弹出授权框，用户同意后会允许开发者给用户发送订阅模版消息。当用户点击“允许”按钮时，模板消息会被添加到用户的小程序设置页，通过 wx.getSetting 接口可获取用户对相关模板消息的订阅状态。
-     * @supported weapp
+     * @supported weapp, tt
      * @example
      * ```tsx
      * Taro.requestSubscribeDeviceMessage({

package/types/api/open-api/user-info.d.ts

@@ -102,7 +102,7 @@ declare module '../../index' {
      *
      * **接口调整说明**
      * 在用户未授权过的情况下调用此接口，将不再出现授权弹窗，会直接进入 fail 回调（详见[《公告》](https://developers.weixin.qq.com/community/develop/doc/0000a26e1aca6012e896a517556c01))。在用户已授权的情况下调用此接口，可成功获取用户信息。
-     * @supported weapp
+     * @supported weapp, tt
      * @example
      * ```tsx
      * // 必须是在用户已经授权的情况下调用
@@ -153,7 +153,7 @@ declare module '../../index' {
      * 开发者每次通过该接口获取用户个人信息均需用户确认，请开发者妥善保管用户快速填写的头像昵称，避免重复弹窗。
      *
      * [微信端调整背景和说明，请参考文档](https://developers.weixin.qq.com/community/develop/doc/000cacfa20ce88df04cb468bc52801)
-     * @supported weapp
+     * @supported weapp, tt
      * @example
      * 推荐使用 Taro.getUserProfile 获取用户信息，开发者每次通过该接口获取用户个人信息均需用户确认
      *

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

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

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

@@ -181,7 +181,7 @@ declare module '../../index' {
     updateShareMenu(option: updateShareMenu.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 显示当前页面的转发按钮
-     * @supported weapp, qq
+     * @supported weapp, qq, tt
      * @example
      * ```tsx
      * Taro.showShareMenu({
@@ -273,7 +273,7 @@ declare module '../../index' {
     ): void
 
     /** 隐藏当前页面的转发按钮
-     * @supported weapp
+     * @supported weapp, tt
      * @example
      * ```tsx
      * Taro.hideShareMenu()

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

@@ -104,7 +104,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** Taro.setStorage 的同步版本
-     * @supported weapp, h5
+     * @supported weapp, h5, tt
      * @example
      * ```tsx
      * Taro.setStorage({
@@ -128,7 +128,7 @@ declare module '../../index' {
     ): void
 
     /** 将数据存储在本地缓存中指定的 key 中。会覆盖掉原来该 key 对应的内容。除非用户主动删除或因存储空间原因被系统清理，否则数据都一直可用。单个 key 允许存储的最大数据长度为 1MB，所有数据存储上限为 10MB。
-     * @supported weapp, h5, rn
+     * @supported weapp, h5, rn, tt
      * @example
      * ```tsx
      * Taro.setStorage({
@@ -155,7 +155,7 @@ declare module '../../index' {
     ): void
 
     /** Taro.removeStorage 的同步版本
-     * @supported weapp, h5
+     * @supported weapp, h5, tt
      * @example
      * ```tsx
      * try {
@@ -172,7 +172,7 @@ declare module '../../index' {
     ): void
 
     /** 从本地缓存中移除指定 key
-     * @supported weapp, h5, rn
+     * @supported weapp, h5, rn, tt
      * @example
      * ```tsx
      * Taro.removeStorage({
@@ -187,7 +187,7 @@ declare module '../../index' {
     removeStorage(option: removeStorage.Option): Promise<TaroGeneral.CallbackResult>
 
     /** Taro.getStorage 的同步版本
-     * @supported weapp, h5
+     * @supported weapp, h5, tt
      * @example
      * ```tsx
      * try {
@@ -207,7 +207,7 @@ declare module '../../index' {
     ): T
 
     /** Taro.getStorageInfo 的同步版本
-     * @supported weapp, h5
+     * @supported weapp, h5, rn, tt
      * @example
      * ```tsx
      * try {
@@ -224,7 +224,7 @@ declare module '../../index' {
     getStorageInfoSync(): getStorageInfoSync.Option
 
     /** 异步获取当前storage的相关信息
-     * @supported weapp, h5, rn
+     * @supported weapp, h5, rn, tt
      * @example
      * ```tsx
      * Taro.getStorageInfo({
@@ -240,7 +240,7 @@ declare module '../../index' {
     getStorageInfo(option?: getStorageInfo.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 从本地缓存中异步获取指定 key 的内容
-     * @supported weapp, h5, rn
+     * @supported weapp, h5, rn, tt
      * @example
      * ```tsx
      * Taro.getStorage({
@@ -264,7 +264,7 @@ declare module '../../index' {
     ): void
 
     /** Taro.clearStorage 的同步版本
-     * @supported weapp, h5
+     * @supported weapp, h5, tt
      * @example
      * ```tsx
      * try {
@@ -278,7 +278,7 @@ declare module '../../index' {
     clearStorageSync(): void
 
     /** 清理本地数据缓存
-     * @supported weapp, h5, rn
+     * @supported weapp, h5, rn, tt
      * @example
      * ```tsx
      * Taro.clearStorage()