@tarojs/taro 3.5.0-canary.1 → 3.5.0

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

@@ -4,7 +4,7 @@ declare module '../../index' {
   namespace requestSubscribeMessage {
     interface Option {
       /** 需要订阅的消息模板的id的集合（注意：iOS客户端7.0.6版本、Android客户端7.0.7版本之后的一次性订阅/长期订阅才支持多个模板消息，iOS客户端7.0.5版本、Android客户端7.0.6版本之前的一次订阅只支持一个模板消息）消息模板id在[微信公众平台(mp.weixin.qq.com)-功能-订阅消息]中配置 */
-      tmplIds: any[]
+      tmplIds: string[]
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
@@ -36,19 +36,81 @@ declare module '../../index' {
        * @name [TEMPLATE_ID]
        * @type "accept" | "reject" | "ban"
        */
-      [TEMPLATE_ID: string]: keyof template_reflex | string
+      [TEMPLATE_ID: string]: keyof TemplateReflex | string
       /** 接口调用成功时errMsg值为'requestSubscribeMessage:ok' */
       errMsg: string
     }
 
     /** 模版消息订阅类型 */
-    interface template_reflex {
+    interface TemplateReflex {
       /** 表示用户同意订阅该条id对应的模板消息 */
       accept
       /** 表示用户拒绝订阅该条id对应的模板消息 */
       reject
       /** 表示已被后台封禁 */
       ban
+      /** 表示该模板因为模板标题同名被后台过滤 */
+      filter
+    }
+  }
+
+  namespace requestSubscribeDeviceMessage {
+    interface Option {
+      /** 需要订阅的消息模板的 id 的集合，一次调用最多可订阅3条消息 */
+      tmplIds: string[]
+      /** 设备唯一序列号。由厂商分配，长度不能超过128字节。字符只接受数字，大小写字母，下划线（_）和连字符（-）。 */
+      sn: string
+      /** 设备票据，5分钟内有效。 */
+      snTicket: string
+      /** 设备型号 id 。通过微信公众平台注册设备获得。 */
+      modelId: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (result: FailCallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+
+    interface FailCallbackResult extends TaroGeneral.CallbackResult {
+      /** 接口调用失败错误码，有可能为空 */
+      errCode: number
+      /** 接口调用失败错误信息 */
+      errMsg: string
+    }
+
+    /**
+     * @example
+     * 表示用户同意订阅 zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE 这条消息
+     * ```json
+     * {
+     *   "errMsg": "requestSubscribeDeviceMessage:ok",
+     *   "zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE": "accept"
+     * }
+     * ```
+     */
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** [TEMPLATE_ID]是动态的键，即模板id
+       * @name [TEMPLATE_ID]
+       * @type "accept" | "reject" | "ban" | "filter" | "acceptWithAudio"
+       */
+      [TEMPLATE_ID: string]: keyof TemplateReflex | string
+      /** 接口调用成功时errMsg值为'requestSubscribeMessage:ok' */
+      errMsg: string
+    }
+
+    /** 模版消息订阅类型 */
+    interface TemplateReflex {
+      /** 表示用户同意订阅该条id对应的模板消息 */
+      accept
+      /** 表示用户拒绝订阅该条id对应的模板消息 */
+      reject
+      /** 表示已被后台封禁 */
+      ban
+      /** 表示该模板因为模板标题同名被后台过滤 */
+      filter
+      /** 表示用户接收订阅消息并开启了语音提醒 */
+      acceptWithAudio
     }
   }
 
@@ -56,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({
@@ -69,5 +131,28 @@ declare module '../../index' {
     requestSubscribeMessage(
       option: requestSubscribeMessage.Option
     ): Promise<requestSubscribeMessage.SuccessCallbackResult | requestSubscribeMessage.FailCallbackResult>
+
+    /** 订阅设备消息接口，调用后弹出授权框，用户同意后会允许开发者给用户发送订阅模版消息。当用户点击“允许”按钮时，模板消息会被添加到用户的小程序设置页，通过 wx.getSetting 接口可获取用户对相关模板消息的订阅状态。
+     * @supported weapp, tt
+     * @example
+     * ```tsx
+     * Taro.requestSubscribeDeviceMessage({
+     *   tmplIds: ['xxxxx'],
+     *   sn: 'xxxx',
+     *   snTicket: 'xxxxx',
+     *   modelId: 'xxx',
+     *   success(res) {
+     *     console.log(res)
+     *   },
+     *   fail(res) {
+     *     console.log(res)
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/subscribe-message/wx.requestSubscribeDeviceMessage.html
+     */
+     requestSubscribeDeviceMessage(
+      option: requestSubscribeDeviceMessage.Option
+    ): Promise<requestSubscribeDeviceMessage.SuccessCallbackResult | requestSubscribeDeviceMessage.FailCallbackResult>
   }
 }

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

@@ -8,7 +8,7 @@ declare module '../../index' {
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
       /** 显示用户信息的语言 */
-      lang?: keyof UserInfo.language
+      lang?: keyof UserInfo.Language
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
       /** 是否带上登录态信息。当 withCredentials 为 true 时，要求此前有调用过 Taro.login 且登录态尚未过期，此时返回的数据会包含 encryptedData, iv 等敏感信息；当 withCredentials 为 false 时，不要求有登录态，返回的数据不包含 encryptedData, iv 等敏感信息。 */
@@ -18,9 +18,9 @@ declare module '../../index' {
     interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 敏感数据对应的云 ID，开通[云开发](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/basis/getting-started.html)的小程序才会返回，可通过云调用直接获取开放数据，详细见[云调用直接获取开放数据](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#method-cloud) */
       cloudID?: string
-      /** 包括敏感数据在内的完整用户信息的加密数据，详见 [用户数据的签名验证和加解密]((signature#加密数据解密算法)) */
+      /** 包括敏感数据在内的完整用户信息的加密数据，详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#%E5%8A%A0%E5%AF%86%E6%95%B0%E6%8D%AE%E8%A7%A3%E5%AF%86%E7%AE%97%E6%B3%95) */
       encryptedData: string
-      /** 加密算法的初始向量，详见 [用户数据的签名验证和加解密]((signature#加密数据解密算法)) */
+      /** 加密算法的初始向量，详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#%E5%8A%A0%E5%AF%86%E6%95%B0%E6%8D%AE%E8%A7%A3%E5%AF%86%E7%AE%97%E6%B3%95) */
       iv: string
       /** 不包括敏感信息的原始数据字符串，用于计算签名 */
       rawData: string
@@ -36,7 +36,7 @@ declare module '../../index' {
   namespace getUserProfile {
     interface Option {
       /** 显示用户信息的语言 */
-      lang?: keyof UserInfo.language
+      lang?: keyof UserInfo.Language
       /** 声明获取用户个人信息后的用途，不超过30个字符 */
       desc: string
       /** 接口调用成功的回调函数 */
@@ -48,7 +48,18 @@ declare module '../../index' {
     }
 
     interface SuccessCallbackResult extends getUserInfo.SuccessCallbackResult {
-      //
+      /** 用户信息对象 */
+      userInfo: UserInfo
+      /** 不包括敏感信息的原始数据字符串，用于计算签名 */
+      rawData: string
+      /** 使用 sha1( rawData + sessionkey ) 得到字符串，用于校验用户信息，详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html) */
+      signature: string
+      /** 包括敏感数据在内的完整用户信息的加密数据，详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#%E5%8A%A0%E5%AF%86%E6%95%B0%E6%8D%AE%E8%A7%A3%E5%AF%86%E7%AE%97%E6%B3%95) */
+      encryptedData: string
+      /** 加密算法的初始向量，详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#%E5%8A%A0%E5%AF%86%E6%95%B0%E6%8D%AE%E8%A7%A3%E5%AF%86%E7%AE%97%E6%B3%95) */
+      iv: string
+      /** 敏感数据对应的云 ID，开通云开发的小程序才会返回，可通过云调用直接获取开放数据，详细 [见云调用直接获取开放数据](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#method-cloud) */
+      cloudID: string
     }
   }
 
@@ -56,30 +67,30 @@ declare module '../../index' {
    * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/user-info/UserInfo.html
    */
   interface UserInfo {
+    /** 用户昵称 */
+    nickName: string
     /** 用户头像图片的 URL。URL 最后一个数值代表正方形头像大小（有 0、46、64、96、132 数值可选，0 代表 640x640 的正方形头像，46 表示 46x46 的正方形头像，剩余数值以此类推。默认132），用户没有头像时该项为空。若用户更换头像，原有头像 URL 将失效。 */
     avatarUrl: string
-    /** 用户所在城市 */
-    city: string
-    /** 用户所在国家 */
+    /** 用户性别。不再返回，参考 [相关公告](https://developers.weixin.qq.com/community/develop/doc/00028edbe3c58081e7cc834705b801) */
+    gender?: keyof UserInfo.Gender
+    /** 用户所在国家。不再返回，参考 [相关公告](https://developers.weixin.qq.com/community/develop/doc/00028edbe3c58081e7cc834705b801) */
     country: string
-    /** 用户性别 */
-    gender: keyof UserInfo.gender
-    /** 显示 country，province，city 所用的语言 */
-    language: keyof UserInfo.language
-    /** 用户昵称 */
-    nickName: string
-    /** 用户所在省份 */
+    /** 用户所在省份。不再返回，参考 [相关公告](https://developers.weixin.qq.com/community/develop/doc/00028edbe3c58081e7cc834705b801) */
     province: string
+    /** 用户所在城市。不再返回，参考 [相关公告](https://developers.weixin.qq.com/community/develop/doc/00028edbe3c58081e7cc834705b801) */
+    city: string
+    /** 显示 country，province，city 所用的语言。强制返回 “zh_CN”，参考 [相关公告](https://developers.weixin.qq.com/community/develop/doc/00028edbe3c58081e7cc834705b801) */
+    language: keyof UserInfo.Language
   }
 
   namespace UserInfo {
-    interface language {
+    interface Language {
       en: '英文'
       zh_CN: '简体中文'
       zh_TW: '繁体中文'
     }
 
-    interface gender {
+    interface Gender {
       0: '未知'
       1: '男性'
       2: '女性'
@@ -91,10 +102,11 @@ declare module '../../index' {
      *
      * **接口调整说明**
      * 在用户未授权过的情况下调用此接口，将不再出现授权弹窗，会直接进入 fail 回调（详见[《公告》](https://developers.weixin.qq.com/community/develop/doc/0000a26e1aca6012e896a517556c01))。在用户已授权的情况下调用此接口，可成功获取用户信息。
-     * @supported weapp
+     * @supported weapp, tt
      * @example
      * ```tsx
      * // 必须是在用户已经授权的情况下调用
+     *
      * Taro.getUserInfo({
      *   success: function(res) {
      *     var userInfo = res.userInfo
@@ -108,7 +120,7 @@ declare module '../../index' {
      * })
      * ```
      *
-     * 敏感数据有两种获取方式，一是使用 [加密数据解密算法]((open-ability/signature#加密数据解密算法)) 。
+     * 敏感数据有两种获取方式，一是使用 [加密数据解密算法](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#%E5%8A%A0%E5%AF%86%E6%95%B0%E6%8D%AE%E8%A7%A3%E5%AF%86%E7%AE%97%E6%B3%95) 。
      * 获取得到的开放数据为以下 json 结构：
      *
      * ```json
@@ -133,6 +145,31 @@ declare module '../../index' {
 
     /**
      * 获取用户信息。每次请求都会弹出授权窗口，用户同意后返回 `userInfo`。
+     *
+     * 若开发者需要获取用户的个人信息（头像、昵称、性别与地区），可以通过 Taro.getUserProfile 接口进行获取，
+     *
+     * 微信该接口从基础库 **2.10.4** 版本开始支持，该接口只返回用户个人信息，不包含用户身份标识符。该接口中 desc 属性（声明获取用户个人信息后的用途）后续会展示在弹窗中，请开发者谨慎填写。
+     *
+     * 开发者每次通过该接口获取用户个人信息均需用户确认，请开发者妥善保管用户快速填写的头像昵称，避免重复弹窗。
+     *
+     * [微信端调整背景和说明，请参考文档](https://developers.weixin.qq.com/community/develop/doc/000cacfa20ce88df04cb468bc52801)
+     * @supported weapp, tt
+     * @example
+     * 推荐使用 Taro.getUserProfile 获取用户信息，开发者每次通过该接口获取用户个人信息均需用户确认
+     *
+     * ```tsx
+     * Taro.getUserProfile({
+     *   desc: '用于完善会员资料', // 声明获取用户个人信息后的用途，后续会展示在弹窗中，请谨慎填写
+     *   success: (res) => {
+     *     // 开发者妥善保管用户快速填写的头像昵称，避免重复弹窗
+     *     this.setState({
+     *       userInfo: res.userInfo,
+     *       hasUserInfo: true
+     *     })
+     *   }
+     * })
+     * ```
+     * @since 2.2.17+，3.0.29+
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/user-info/wx.getUserProfile.html
      */
     getUserProfile(option: getUserProfile.Option): Promise<getUserProfile.SuccessCallbackResult>

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

@@ -1,19 +1,40 @@
 import Taro from '../../index'
 
 declare module '../../index' {
-  namespace getWeRunData {
+  namespace shareToWeRun {
     interface Option {
+      /** 运动数据列表 */
+      recordList: record[]
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
-      success?: (result: SuccessCallback) => void
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+    interface record {
+      /** 运动项目id */
+      typeId: number
+      /** 运动时长 */
+      time: number
+      /** 运动距离 */
+      distance: number
+      /** 消耗卡路里 */
+      calorie: number
     }
+  }
 
-    type SuccessCallback = (
-      result: SuccessCallbackResult,
-    ) => void
+  namespace getWeRunData {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (
+        result: SuccessCallbackResult,
+      ) => void
+    }
 
     interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 敏感数据对应的云 ID，开通云开发的小程序才会返回，可通过云调用直接获取开放数据，详细见[云调用直接获取开放数据](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#method-cloud) */
@@ -28,6 +49,12 @@ declare module '../../index' {
   }
 
   interface TaroStatic {
+    /** 分享数据到微信运动。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/werun/wx.shareToWeRun.html
+     */
+    shareToWeRun(option?: shareToWeRun.Option): Promise<TaroGeneral.CallbackResult>
+
     /** 获取用户过去三十天微信运动步数。需要先调用 Taro.login 接口。步数信息会在用户主动进入小程序时更新。
      * @supported weapp
      * @example
@@ -43,7 +70,7 @@ declare module '../../index' {
      * ```
      *
      * **开放数据 JSON 结构**
-     * 敏感数据有两种获取方式，一是使用 [加密数据解密算法]((open-ability/signature#加密数据解密算法)) 。
+     * 敏感数据有两种获取方式，一是使用 [加密数据解密算法](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#%E5%8A%A0%E5%AF%86%E6%95%B0%E6%8D%AE%E8%A7%A3%E5%AF%86%E7%AE%97%E6%B3%95) 。
      * 获取得到的开放数据为以下 json 结构：
      *
      * ```json

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

@@ -0,0 +1,119 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace requestPayment {
+    interface Option {
+      /** 时间戳，从 1970 年 1 月 1 日 00:00:00 至今的秒数，即当前的时间 */
+      timeStamp: string
+      /** 随机字符串，长度为32个字符以下 */
+      nonceStr: string
+      /** 统一下单接口返回的 prepay_id 参数值，提交格式如：prepay_id=*** */
+      package: string
+      /** 签名算法 */
+      signType?: keyof SignType
+      /** 签名，具体签名方案参见 [小程序支付接口文档](https://pay.weixin.qq.com/wiki/doc/api/wxa/wxa_api.php?chapter=7_7&index=3) */
+      paySign: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+
+    interface SignType {
+      /** 仅在微信支付 v2 版本接口适用 */
+      MD5
+      /** 仅在微信支付 v2 版本接口适用 */
+      'HMAC-SHA256'
+      /** 仅在微信支付 v3 版本接口适用 */
+      RSA
+    }
+  }
+
+  namespace requestOrderPayment {
+    interface Option {
+      /** 时间戳，从 1970 年 1 月 1 日 00:00:00 至今的秒数，即当前的时间 */
+      timeStamp: string
+      /** 随机字符串，长度为32个字符以下 */
+      nonceStr: string
+      /** 统一下单接口返回的 prepay_id 参数值，提交格式如：prepay_id=*** */
+      package: string
+      /** 订单信息，仅在需要校验的场景下需要传递，具体见[接口说明](https://developers.weixin.qq.com/miniprogram/dev/framework/ministore/minishopopencomponent2/API/order/requestOrderPayment) */
+      orderInfo?
+      /** 外部 APP 用户 ID */
+      extUserUin?: string
+      /** 签名算法 */
+      signType?: keyof SignType
+      /** 签名，具体签名方案参见 [小程序支付接口文档](https://pay.weixin.qq.com/wiki/doc/api/wxa/wxa_api.php?chapter=7_7&index=3) */
+      paySign: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+
+    interface SignType {
+      /** 仅在微信支付 v2 版本接口适用 */
+      MD5
+      /** 仅在微信支付 v2 版本接口适用 */
+      'HMAC-SHA256'
+      /** 仅在微信支付 v3 版本接口适用 */
+      RSA
+    }
+  }
+
+  interface TaroStatic {
+    /** 发起微信支付。了解更多信息，请查看[微信支付接口文档](https://pay.weixin.qq.com/wiki/doc/api/wxa/wxa_api.php?chapter=7_3&index=1)
+     * @supported weapp, h5
+     * @example
+     * ```tsx
+     * Taro.requestPayment({
+     *   timeStamp: '',
+     *   nonceStr: '',
+     *   package: '',
+     *   signType: 'MD5',
+     *   paySign: '',
+     *   success: function (res) { },
+     *   fail: function (res) { }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/payment/wx.requestPayment.html
+     */
+    requestPayment(option: requestPayment.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 创建自定义版交易组件订单，并发起支付。 仅接入了[自定义版交易组件](https://developers.weixin.qq.com/miniprogram/dev/framework/ministore/minishopopencomponent2/Introduction2)的小程序需要使用，普通小程序可直接使用 `Taro.requestPayment`。
+     * @supported weapp
+     * @example
+     * 除 orderInfo 以外，其余字段与 [Taro.requestPayment](./requestPayment) 一致
+     *
+     * ```tsx
+     * Taro.requestOrderPayment({
+     *   orderInfo: {},
+     *   timeStamp: '',
+     *   nonceStr: '',
+     *   package: '',
+     *   signType: 'MD5',
+     *   paySign: '',
+     *   success (res) { },
+     *   fail (res) { }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/payment/wx.requestOrderPayment.html
+     */
+    requestOrderPayment(option: requestOrderPayment.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 支付各个安全场景验证人脸
+     * @supported weapp
+     * @deprecated
+     * @example
+     * ```tsx
+     * Taro.faceVerifyForPay(params).then(...)
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/payment/wx.faceVerifyForPay.html
+     */
+    faceVerifyForPay(option: any): Promise<any>
+  }
+}

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

@@ -68,6 +68,10 @@ declare module '../../index' {
     }
   }
 
+  /** 页面间事件通信通道
+   * @supported weapp
+   * @see https://developers.weixin.qq.com/miniprogram/dev/api/route/EventChannel.html
+   */
   interface EventChannel {
     /** 触发一个事件
      * @supported weapp
@@ -79,31 +83,31 @@ declare module '../../index' {
       /** 事件参数 */
       ...args: any
     ): void
-    /** 取消监听一个事件。给出第二个参数时，只取消给出的监听函数，否则取消所有监听函数
+    /** 持续监听一个事件
      * @supported weapp
-     * @see https://developers.weixin.qq.com/miniprogram/dev/api/route/EventChannel.off.html
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/route/EventChannel.on.html
      */
-    off(
+    on(
       /** 事件名称 */
       eventName: string,
       /** 事件监听函数 */
       fn: TaroGeneral.EventCallback,
     ): void
-    /** 持续监听一个事件
+    /** 监听一个事件一次，触发后失效
      * @supported weapp
-     * @see https://developers.weixin.qq.com/miniprogram/dev/api/route/EventChannel.on.html
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/route/EventChannel.once.html
      */
-    on(
+    once(
       /** 事件名称 */
       eventName: string,
       /** 事件监听函数 */
       fn: TaroGeneral.EventCallback,
     ): void
-    /** 监听一个事件一次，触发后失效
+    /** 取消监听一个事件。给出第二个参数时，只取消给出的监听函数，否则取消所有监听函数
      * @supported weapp
-     * @see https://developers.weixin.qq.com/miniprogram/dev/api/route/EventChannel.once.html
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/route/EventChannel.off.html
      */
-    once(
+    off(
       /** 事件名称 */
       eventName: string,
       /** 事件监听函数 */
@@ -113,7 +117,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面
-     * @supported weapp, h5, rn
+     * @supported weapp, h5, rn, tt
      * @example
      * ```json
      * {
@@ -139,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({
@@ -151,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({
@@ -163,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({
@@ -189,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 方法则不会。见下方示例代码