@tarojs/taro 3.4.1 → 3.4.2

package/types/api/media/voip.d.ts

@@ -0,0 +1,290 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace updateVoIPChatMuteConfig {
+    interface Option {
+      /** 静音设置 */
+      muteConfig: MuteConfig
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+    /** 静音设置 */
+    interface MuteConfig {
+      /** 是否静音麦克风 */
+      muteMicrophone?: boolean
+      /** 是否静音耳机 */
+      muteEarphone?: boolean
+    }
+  }
+
+  namespace subscribeVoIPVideoMembers {
+    interface Option {
+      /** 订阅的成员列表 */
+      openIdList: string[]
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace setEnable1v1Chat {
+    interface Option {
+      /** 是否开启 */
+      enable: boolean
+      /** 窗口背景色
+       * @default 0
+       */
+      backgroundType?: keyof ColorType
+      /** 小窗样式
+       * @default 1
+       */
+      minWindowType?: keyof ColorType
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+    /** 音频通话背景以及小窗模式背景 */
+    interface ColorType {
+      /** #262930 */
+      0
+      /** #FA5151 */
+      1
+      /** #FA9D3B */
+      2
+      /** #3D7257 */
+      3
+      /** #1485EE */
+      4
+      /** #6467F0 */
+      5
+    }
+  }
+
+  namespace onVoIPVideoMembersChanged {
+    interface Result extends TaroGeneral.CallbackResult {
+      /** 开启视频的成员名单 */
+      openIdList: string[]
+      /** 错误码 */
+      errCode: number
+      /** 调用结果 */
+      errMsg: string
+    }
+    /** 实时语音通话成员视频状态变化事件的回调函数 */
+    type Callback = (res: Result) => void
+  }
+
+  namespace onVoIPChatStateChanged {
+    interface Result extends TaroGeneral.CallbackResult {
+      /** 事件码 */
+      code: number
+      /** 附加信息 */
+      data: Record<any, any>
+      /** 错误码 */
+      errCode: number
+      /** 调用结果 */
+      errMsg: string
+    }
+    /** 房间状态变化事件的回调函数 */
+    type Callback = (res: Result) => void
+  }
+
+  namespace onVoIPChatSpeakersChanged {
+    interface Result extends TaroGeneral.CallbackResult {
+      /** 还在实时语音通话中的成员 openId 名单 */
+      openIdList: string[]
+      /** 错误码 */
+      errCode: number
+      /** 调用结果 */
+      errMsg: string
+    }
+    /** 房间状态变化事件的回调函数 */
+    type Callback = (res: Result) => void
+  }
+
+  namespace onVoIPChatMembersChanged {
+    interface Result extends TaroGeneral.CallbackResult {
+      /** 还在实时语音通话中的成员 openId 名单 */
+      openIdList: string[]
+      /** 错误码 */
+      errCode: number
+      /** 调用结果 */
+      errMsg: string
+    }
+    /** 房间状态变化事件的回调函数 */
+    type Callback = (res: Result) => void
+  }
+
+  namespace onVoIPChatInterrupted {
+    interface Result extends TaroGeneral.CallbackResult {
+      /** 还在实时语音通话中的成员 openId 名单 */
+      openIdList: string[]
+      /** 错误码 */
+      errCode: number
+      /** 调用结果 */
+      errMsg: string
+    }
+    /** 房间状态变化事件的回调函数 */
+    type Callback = (res: Result) => void
+  }
+
+  namespace joinVoIPChat {
+    type Promised = FailCallbackResult | SuccessCallbackResult
+    interface Option {
+      /** 房间类型
+       * @default "voice"
+       */
+      roomType?: RoomType
+      /** 签名，用于验证小游戏的身份 */
+      signature: string
+      /** 验证所需的随机字符串 */
+      nonceStr: string
+      /** 验证所需的时间戳 */
+      timeStamp: number
+      /** 小游戏内此房间/群聊的 ID。同一时刻传入相同 groupId 的用户会进入到同个实时语音房间。 */
+      groupId: string
+      /** 静音设置 */
+      muteConfig?: MuteConfig
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+    /** 房间类型 */
+    interface RoomType {
+      /** 音频房间，用于语音通话 */
+      voice
+      /** 视频房间，结合 [voip-room](/docs/components/media/voip-room) 组件可显示成员画面 */
+      video
+    }
+    /** 静音设置 */
+    interface MuteConfig {
+      /** 是否静音麦克风 */
+      muteMicrophone?: boolean
+      /** 是否静音耳机 */
+      muteEarphone?: boolean
+    }
+    interface FailCallbackResult extends TaroGeneral.CallbackResult {
+      /** 错误信息 */
+      errMsg: string
+      /** 错误码 */
+      errCode: keyof VoipErrCode
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 还在实时语音通话中的成员 openId 名单 */
+      openIdList: string[]
+      /** 错误码 */
+      errCode: number
+      /** 调用结果 */
+      errMsg: string
+    }
+    /** Voip 错误码 */
+    interface VoipErrCode {
+      /** 当前已在房间内 */
+      [-1]
+      /** 录音设备被占用，可能是当前正在使用微信内语音通话或系统通话 */
+      [-2]
+      /** 加入会话期间退出（可能是用户主动退出，或者退后台、来电等原因），因此加入失败 */
+      [-3]
+      /** 系统错误 */
+      [-1000]
+    }
+  }
+
+  namespace exitVoIPChat {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  interface TaroStatic {
+    /** 更新实时语音静音设置
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.updateVoIPChatMuteConfig.html
+     */
+    updateVoIPChatMuteConfig(option: updateVoIPChatMuteConfig.Option): Promise<TaroGeneral.CallbackResult>
+    /** 订阅视频画面成员
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.subscribeVoIPVideoMembers.html
+     */
+    subscribeVoIPVideoMembers(option: subscribeVoIPVideoMembers.Option): Promise<TaroGeneral.CallbackResult>
+    /** 开启双人通话
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.setEnable1v1Chat.html
+     */
+    setEnable1v1Chat(option: subscribeVoIPVideoMembers.Option): Promise<TaroGeneral.CallbackResult>
+    /** 监听实时语音通话成员视频状态变化事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.onVoIPVideoMembersChanged.html
+     */
+    onVoIPVideoMembersChanged(callback: onVoIPVideoMembersChanged.Callback): void
+    /** 监听房间状态变化事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.onVoIPChatStateChanged.html
+     */
+    onVoIPChatStateChanged(callback: onVoIPChatStateChanged.Callback): void
+    /** 监听实时语音通话成员通话状态变化事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.onVoIPChatSpeakersChanged.html
+     */
+    onVoIPChatSpeakersChanged(callback: onVoIPChatSpeakersChanged.Callback): void
+    /** 监听实时语音通话成员在线状态变化事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.onVoIPChatMembersChanged.html
+     */
+    onVoIPChatMembersChanged(callback: onVoIPChatMembersChanged.Callback): void
+    /** 监听被动断开实时语音通话事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.onVoIPChatInterrupted.html
+     */
+    onVoIPChatInterrupted(callback: onVoIPChatInterrupted.Callback): void
+    /** 取消监听实时语音通话成员视频状态变化事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.offVoIPVideoMembersChanged.html
+     */
+    offVoIPVideoMembersChanged(callback: onVoIPVideoMembersChanged.Callback): void
+    /** 取消监听房间状态变化事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.offVoIPChatStateChanged.html
+     */
+    offVoIPChatStateChanged(callback: onVoIPChatStateChanged.Callback): void
+    /** 取消监听实时语音通话成员在线状态变化事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.offVoIPChatMembersChanged.html
+     */
+    offVoIPChatMembersChanged(callback: onVoIPChatMembersChanged.Callback): void
+    /** 取消监听被动断开实时语音通话事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.offVoIPChatInterrupted.html
+     */
+    offVoIPChatInterrupted(callback: onVoIPChatInterrupted.Callback): void
+    /** 加入 (创建) 实时语音通话，更多信息可见 [实时语音指南](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/voip-chat.html)
+     * 
+     * 调用前需要用户授权 `scope.record`，若房间类型为视频房间需要用户授权 `scope.camera`。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.joinVoIPChat.html
+     */
+    joinVoIPChat(option: joinVoIPChat.Option): Promise<joinVoIPChat.Promised>
+    /** 退出（销毁）实时语音通话
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.exitVoIPChat.html
+     */
+    exitVoIPChat(option: exitVoIPChat.Option): Promise<TaroGeneral.CallbackResult>
+  }
+}

package/types/api/{open-api/navigate.d.ts → navigate/index.d.ts}

@@ -1,14 +1,33 @@
 import Taro from '../../index'
 
 declare module '../../index' {
-  namespace exitMiniProgram {
+  namespace openEmbeddedMiniProgram {
     interface Option {
-      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: TaroGeneral.CallbackResult) => void
-      /** 接口调用失败的回调函数 */
-      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 要打开的小程序 appId */
+      appId: string
+      /** 打开的页面路径，如果为空则打开首页。path 中 ? 后面的部分会成为 query，在小程序的 `App.onLaunch`、`App.onShow` 和 `Page.onLoad` 的回调函数或小游戏的 [Taro.onShow](#) 回调函数、[Taro.getLaunchOptionsSync](/docs/apis/base/weapp/life-cycle/getLaunchOptionsSync) 中可以获取到 query 数据。对于小游戏，可以只传入 query 部分，来实现传参效果，如：传入 "?foo=bar"。 */
+      path?: string
+      /** 需要传递给目标小程序的数据，目标小程序可在 `App.onLaunch`，`App.onShow` 中获取到这份数据。如果跳转的是小游戏，可以在 [Taro.onShow](#)、[Taro.getLaunchOptionsSync](/docs/apis/base/weapp/life-cycle/getLaunchOptionsSync) 中可以获取到这份数据数据。 */
+      extraData?: TaroGeneral.IAnyObject
+      /** 要打开的小程序版本。仅在当前小程序为开发版或体验版时此参数有效。如果当前小程序是正式版，则打开的小程序必定是正式版。*/
+      envVersion?: keyof EnvVersion
+      /** 小程序链接，当传递该参数后，可以不传 appId 和 path。链接可以通过【小程序菜单】->【复制链接】获取。 */
+      shortLink?: string
       /** 接口调用成功的回调函数 */
       success?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+    }
+
+    interface EnvVersion {
+      /** 开发版 */
+      develop
+      /** 体验版 */
+      trial
+      /** 正式版 */
+      release
     }
   }
 
@@ -16,21 +35,23 @@ declare module '../../index' {
     interface Option {
       /** 要打开的小程序 appId */
       appId: string
-      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: TaroGeneral.CallbackResult) => void
-      /** 要打开的小程序版本。仅在当前小程序为开发版或体验版时此参数有效。如果当前小程序是正式版，则打开的小程序必定是正式版。*/
-      envVersion?: keyof envVersion
-      /** 需要传递给目标小程序的数据，目标小程序可在 `App.onLaunch`，`App.onShow` 中获取到这份数据。如果跳转的是小游戏，可以在 [wx.onShow](#)、[wx.getLaunchOptionsSync](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/life-cycle/wx.getLaunchOptionsSync.html) 中可以获取到这份数据数据。 */
-      extraData?: TaroGeneral.IAnyObject
-      /** 接口调用失败的回调函数 */
-      fail?: (res: TaroGeneral.CallbackResult) => void
-      /** 打开的页面路径，如果为空则打开首页。path 中 ? 后面的部分会成为 query，在小程序的 `App.onLaunch`、`App.onShow` 和 `Page.onLoad` 的回调函数或小游戏的 [wx.onShow](#) 回调函数、[wx.getLaunchOptionsSync](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/life-cycle/wx.getLaunchOptionsSync.html) 中可以获取到 query 数据。对于小游戏，可以只传入 query 部分，来实现传参效果，如：传入 "?foo=bar"。 */
+      /** 打开的页面路径，如果为空则打开首页。path 中 ? 后面的部分会成为 query，在小程序的 `App.onLaunch`、`App.onShow` 和 `Page.onLoad` 的回调函数或小游戏的 [Taro.onShow](#) 回调函数、[Taro.getLaunchOptionsSync](/docs/apis/base/weapp/life-cycle/getLaunchOptionsSync) 中可以获取到 query 数据。对于小游戏，可以只传入 query 部分，来实现传参效果，如：传入 "?foo=bar"。 */
       path?: string
+      /** 需要传递给目标小程序的数据，目标小程序可在 `App.onLaunch`，`App.onShow` 中获取到这份数据。如果跳转的是小游戏，可以在 [Taro.onShow](#)、[Taro.getLaunchOptionsSync](/docs/apis/base/weapp/life-cycle/getLaunchOptionsSync) 中可以获取到这份数据数据。 */
+      extraData?: TaroGeneral.IAnyObject
+      /** 要打开的小程序版本。仅在当前小程序为开发版或体验版时此参数有效。如果当前小程序是正式版，则打开的小程序必定是正式版。*/
+      envVersion?: keyof EnvVersion
+      /** 小程序链接，当传递该参数后，可以不传 appId 和 path。链接可以通过【小程序菜单】->【复制链接】获取。 */
+      shortLink?: string
       /** 接口调用成功的回调函数 */
       success?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
     }
 
-    interface envVersion {
+    interface EnvVersion {
       /** 开发版 */
       develop
       /** 体验版 */
@@ -42,28 +63,34 @@ declare module '../../index' {
 
   namespace navigateBackMiniProgram {
     interface Option {
-      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 需要返回给上一个小程序的数据，上一个小程序可在 `App.onShow` 中获取到这份数据。 [详情](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html)。 */
       extraData?: TaroGeneral.IAnyObject
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace exitMiniProgram {
+    interface Option {
       /** 接口调用成功的回调函数 */
       success?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
     }
   }
 
   interface TaroStatic {
-    /** 退出当前小程序。必须有点击行为才能调用成功。
+    /** 打开半屏小程序。接入指引请参考 [半屏小程序能力](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)。
      * @supported weapp
-     * @example
-     * ```tsx
-     * Taro.exitMiniProgram()
-     * ···
-     *
-     * @see https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.exitMiniProgram.html
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.openEmbeddedMiniProgram.html
      */
-    exitMiniProgram(option?: exitMiniProgram.Option): Promise<TaroGeneral.CallbackResult>
+    openEmbeddedMiniProgram(option?: openEmbeddedMiniProgram.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 打开另一个小程序
      *
@@ -115,5 +142,16 @@ declare module '../../index' {
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/miniprogram-navigate/wx.navigateBackMiniProgram.html
      */
     navigateBackMiniProgram(option: navigateBackMiniProgram.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 退出当前小程序。必须有点击行为才能调用成功。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.exitMiniProgram()
+     * ···
+     *
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.exitMiniProgram.html
+     */
+    exitMiniProgram(option?: exitMiniProgram.Option): Promise<TaroGeneral.CallbackResult>
   }
 }

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

@@ -66,22 +66,45 @@ declare module '../../index' {
     }
   }
 
+  /** 一个可以监听下载进度变化事件，以及取消下载任务的对象
+   * @supported weapp, swan, alipay, h5, rn
+   * @example
+   * ```tsx
+   * const downloadTask = Taro.downloadFile({
+   *   url: 'http://example.com/audio/123', //仅为示例，并非真实的资源
+   *   success (res) {
+   *     Taro.playVoice({
+   *       filePath: res.tempFilePath
+   *     })
+   *   }
+   * })
+   *
+   * downloadTask.onProgressUpdate((res) => {
+   *   console.log('下载进度', res.progress)
+   *   console.log('已经下载的数据长度', res.totalBytesWritten)
+   *   console.log('预期需要下载的数据总长度', res.totalBytesExpectedToWrite)
+   * })
+   *
+   * downloadTask.abort() // 取消下载任务
+   * ```
+   * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/download/DownloadTask.html
+   */
   interface DownloadTask {
     /** 中断下载任务
-     * @supported weapp
+     * @supported weapp, h5, rn
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/download/DownloadTask.abort.html
      */
     abort(): void
-    /** 取消监听 HTTP Response Header 事件
-     * @supported weapp
-     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/download/DownloadTask.offHeadersReceived.html
+    /** 监听下载进度变化事件
+     * @supported weapp, h5, rn
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/download/DownloadTask.onProgressUpdate.html
      */
-    offHeadersReceived(
-      /** HTTP Response Header 事件的回调函数 */
-      callback: DownloadTask.OffHeadersReceivedCallback,
+    onProgressUpdate(
+      /** 下载进度变化事件的回调函数 */
+      callback: DownloadTask.OnProgressUpdateCallback,
     ): void
     /** 取消监听下载进度变化事件
-     * @supported weapp
+     * @supported weapp, h5, rn
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/download/DownloadTask.offProgressUpdate.html
      */
     offProgressUpdate(
@@ -89,20 +112,20 @@ declare module '../../index' {
       callback: DownloadTask.OffProgressUpdateCallback,
     ): void
     /** 监听 HTTP Response Header 事件。会比请求完成事件更早
-     * @supported weapp
+     * @supported weapp, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/download/DownloadTask.onHeadersReceived.html
      */
     onHeadersReceived(
       /** HTTP Response Header 事件的回调函数 */
       callback: DownloadTask.OnHeadersReceivedCallback,
     ): void
-    /** 监听下载进度变化事件
-     * @supported weapp
-     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/download/DownloadTask.onProgressUpdate.html
+    /** 取消监听 HTTP Response Header 事件
+     * @supported weapp, h5
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/download/DownloadTask.offHeadersReceived.html
      */
-    onProgressUpdate(
-      /** 下载进度变化事件的回调函数 */
-      callback: DownloadTask.OnProgressUpdateCallback,
+    offHeadersReceived(
+      /** HTTP Response Header 事件的回调函数 */
+      callback: DownloadTask.OffHeadersReceivedCallback,
     ): void
   }
 
@@ -110,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
+     * @supported weapp, h5, alipay, swan, rn
      * @example
      * ```tsx
      * Taro.downloadFile({