@spcsn/taro 0.1.1 → 1.0.0

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

@@ -160,17 +160,17 @@ declare module '../../index' {
   /** `AudioContext` 实例，可通过 `Taro.createAudioContext` 获取。
    *
    * `AudioContext` 通过 `id` 跟一个 `audio` 组件绑定，操作对应的 audio 组件。
-   * @supported weapp, harmony_hybrid
+   * @supported weapp
    * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/AudioContext.html
    */
   interface AudioContext {
     /** 暂停音频。
-     * @supported weapp, harmony_hybrid
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/AudioContext.pause.html
      */
     pause(): void
     /** 播放音频。
-     * @supported weapp, harmony_hybrid
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/AudioContext.play.html
      */
     play(): void
@@ -270,103 +270,103 @@ declare module '../../index' {
     /** origin: 发送完整的 referrer; no-referrer: 不发送 */
     referrerPolicy?: 'origin' | 'no-referrer' | string
     /** 播放
-     * @supported weapp, h5, rn, harmony_hybrid
+     * @supported weapp
      */
     play(): void
     /** 暂停
-     * @supported weapp, h5, rn
+     * @supported weapp
      */
     pause(): void
     /** 停止
-     * @supported weapp, h5, rn, harmony_hybrid
+     * @supported weapp
      */
     stop(): void
     /** 跳转到指定位置，单位 s
-     * @supported weapp, h5, rn
+     * @supported weapp
      */
     seek(position: number): void
     /** 销毁当前实例
-     * @supported weapp, h5
+     * @supported weapp
      */
     destroy(): void
     /** 音频进入可以播放状态，但不保证后面可以流畅播放
-     * @supported weapp, h5, rn
+     * @supported weapp
      */
     onCanplay(callback?: InnerAudioContext.OnCanplayCallback): void
     /** 音频播放事件
-     * @supported weapp, h5, rn, harmony_hybrid
+     * @supported weapp
      */
     onPlay(callback?: InnerAudioContext.OnPlayCallback): void
     /** 音频暂停事件
-     * @supported weapp, h5, rn
+     * @supported weapp
      */
     onPause(callback?: InnerAudioContext.OnPauseCallback): void
     /** 音频停止事件
-     * @supported weapp, h5, rn, harmony_hybrid
+     * @supported weapp
      */
     onStop(callback?: InnerAudioContext.OnStopCallback): void
     /** 音频自然播放结束事件
-     * @supported weapp, h5, rn, harmony_hybrid
+     * @supported weapp
      */
     onEnded(callback?: InnerAudioContext.OnEndedCallback): void
     /** 音频播放进度更新事件
-     * @supported weapp, h5, rn
+     * @supported weapp
      */
     onTimeUpdate(callback?: InnerAudioContext.OnTimeUpdateCallback): void
     /** 音频播放错误事件
-     * @supported weapp, h5, rn, harmony_hybrid
+     * @supported weapp
      */
     onError(callback?: InnerAudioContext.OnErrorCallback): void
     /** 音频加载中事件，当音频因为数据不足，需要停下来加载时会触发
-     * @supported weapp, h5, rn
+     * @supported weapp
      */
     onWaiting(callback?: InnerAudioContext.OnWaitingCallback): void
     /** 音频进行 seek 操作事件
-     * @supported weapp, h5, rn
+     * @supported weapp
      */
     onSeeking(callback?: InnerAudioContext.OnSeekingCallback): void
     /** 音频完成 seek 操作事件
-     * @supported weapp, h5, rn
+     * @supported weapp
      */
     onSeeked(callback?: InnerAudioContext.OnSeekedCallback): void
     /** 取消监听 canplay 事件
-     * @supported weapp, h5, rn
+     * @supported weapp
      */
     offCanplay(callback?: InnerAudioContext.OnCanplayCallback): void
     /** 取消监听 play 事件
-     * @supported weapp, h5, rn
+     * @supported weapp
      */
     offPlay(callback?: InnerAudioContext.OnPlayCallback): void
     /** 取消监听 pause 事件
-     * @supported weapp, h5, rn
+     * @supported weapp
      */
     offPause(callback?: InnerAudioContext.OnPauseCallback): void
     /** 取消监听 stop 事件
-     * @supported weapp, h5, rn
+     * @supported weapp
      */
     offStop(callback?: InnerAudioContext.OnStopCallback): void
     /** 取消监听 ended 事件
-     * @supported weapp, h5, rn
+     * @supported weapp
      */
     offEnded(callback?: InnerAudioContext.OnEndedCallback): void
     /** 取消监听 timeUpdate 事件
-     * @supported weapp, h5, rn
+     * @supported weapp
      */
     offTimeUpdate(callback?: InnerAudioContext.OnTimeUpdateCallback): void
     /** 取消监听 error 事件
-     * @supported weapp, h5, rn
+     * @supported weapp
      */
     offError(callback?: InnerAudioContext.OnErrorCallback): void
     /** 取消监听 waiting 事件
-     * @supported weapp, h5, rn
+     * @supported weapp
      */
     offWaiting(callback?: InnerAudioContext.OnWaitingCallback): void
     /** 取消监听 seeking 事件
-     * @supported weapp, h5, rn
+     * @supported weapp
      */
     offSeeking(callback?: InnerAudioContext.OnSeekingCallback): void
     /** 取消监听 seeked 事件
-     * @supported weapp, h5, rn
+     * @supported weapp
      */
     offSeeked(callback?: InnerAudioContext.OnSeekedCallback): void
   }
@@ -976,7 +976,7 @@ declare module '../../index' {
     createMediaAudioPlayer(): MediaAudioPlayer
 
     /** 创建内部 audio 上下文 InnerAudioContext 对象。
-     * @supported weapp, h5, rn, tt, harmony_hybrid
+     * @supported weapp
      * @example
      * ```tsx
      * const innerAudioContext = Taro.createInnerAudioContext()
@@ -996,7 +996,7 @@ declare module '../../index' {
 
     /** 创建 audio 上下文 AudioContext 对象。
      * **注意：1.6.0 版本开始，本接口不再维护。建议使用能力更强的 [Taro.createInnerAudioContext](./createInnerAudioContext) 接口**
-     * @supported weapp, harmony_hybrid
+     * @supported weapp
      * @example
      * ```tsx
      * const audioCtx = Taro.createAudioContext('myAudio')

package/types/api/media/background-audio.d.ts

@@ -274,7 +274,7 @@ declare module '../../index' {
      * 小程序切入后台，如果音频处于播放状态，可以继续播放。但是后台状态不能通过调用API操纵音频的播放状态。
      *
      * 从微信客户端6.7.2版本开始，若需要在小程序切后台后继续播放音频，需要在 [app.json](https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html) 中配置 `requiredBackgroundModes` 属性。开发版和体验版上可以直接生效，正式版还需通过审核。
-     * @supported weapp, tt, harmony_hybrid
+     * @supported weapp
      * @example
      * ```tsx
      * const backgroundAudioManager = Taro.getBackgroundAudioManager()

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

@@ -10,7 +10,7 @@ declare module '../../index' {
      * ****
      *
      * 注： 使用该接口需同时在 [camera](/docs/components/media/camera) 组件属性中指定 frame-size。
-     * @supported weapp, tt, alipay
+     * @supported weapp
      * @example
      * ```tsx
      * const context = wx.createCameraContext()
@@ -26,22 +26,22 @@ declare module '../../index' {
       callback: CameraContext.OnCameraFrameCallback,
     ): CameraFrameListener
     /** 设置缩放级别
-     * @supported weapp, tt, alipay
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/camera/CameraContext.setZoom.html
      */
     setZoom(option: CameraContext.SetZoomOption): void
     /** 开始录像
-     * @supported weapp, rn, tt, alipay
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/camera/CameraContext.startRecord.html
      */
     startRecord(option: CameraContext.StartRecordOption): void
     /** 结束录像
-     * @supported weapp, rn, tt, alipay
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/camera/CameraContext.stopRecord.html
      */
     stopRecord(option?: CameraContext.StopRecordOption): void
     /** 拍摄照片
-     * @supported weapp, rn, tt, alipay
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/camera/CameraContext.takePhoto.html
      */
     takePhoto(option: CameraContext.TakePhotoOption): void
@@ -61,10 +61,6 @@ declare module '../../index' {
     interface StartRecordSuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 实际设置的缩放级别。由于系统限制，某些机型可能无法设置成指定值，会改用最接近的可设值。 */
       zoom: number
-      /**
-       * @supported alipay
-       * @alipay on android
-       */
       setZoom:number
     }
     interface StartRecordOption {
@@ -86,21 +82,13 @@ declare module '../../index' {
       tempThumbPath: string
       /** 视频的文件的临时路径 */
       tempVideoPath: string
-      /** 视频文件的高度。
-       * @supported alipay
-       */
+      /** 视频文件的高度。 */
       height: string
-      /** 视频文件的宽度。
-       * @supported alipay
-       */
+      /** 视频文件的宽度。 */
       width: string
-      /** 视频文件的尺寸。
-       * @supported alipay
-       */
+      /** 视频文件的尺寸。 */
       size: string
-      /** 录制的持续时间。
-       * @supported alipay
-       */
+      /** 录制的持续时间。 */
       duration: string
     }
     interface StopRecordOption {
@@ -162,12 +150,12 @@ declare module '../../index' {
    */
   interface CameraFrameListener {
     /** 开始监听帧数据
-     * @supported weapp, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/camera/CameraFrameListener.start.html
      */
     start(option?: CameraFrameListener.StartOption): void
     /** 停止监听帧数据
-     * @supported weapp, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/camera/CameraFrameListener.stop.html
      */
     stop(option?: CameraFrameListener.StopOption): void
@@ -194,8 +182,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 创建 camera 上下文 CameraContext 对象。
-     * @alipay 支付宝小程序需指定 camera 组件中的 id 属性
-     * @supported weapp, rn, tt, alipay
+     * @supported weapp
      * @example
      * ```tsx
      * const cameraContext = Taro.createCameraContext()

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

@@ -24,12 +24,10 @@ declare module '../../index' {
       current?: string | number
       /**
        * 是否支持长按下载图片
-       * @supported alipay 基础库: 1.13.0
        */
       enablesavephoto?: boolean
       /**
        * 是否在右下角显示下载入口
-       * @supported alipay 基础库: 1.13.0
        */
       enableShowPhotoDownload?: boolean
       /** @supported weapp 最低版本：2.13.0。是否显示长按菜单，默认值：true */
@@ -141,17 +139,17 @@ declare module '../../index' {
     interface Option {
       /** 最多可以选择的图片张数
        * @default 9
-       * @supported weapp, alipay, swan, tt, h5, rn
+       * @supported weapp
        */
       count?: number
       /** 所选的图片的尺寸
        * @default ['original', 'compressed']
-       * @supported weapp, alipay, swan, tt, rn
+       * @supported weapp
        */
       sizeType?: Array<keyof sizeType>
       /** 选择图片的来源
        * @default ['album', 'camera']
-       * @supported weapp, alipay, swan, tt, h5, rn
+       * @supported weapp
        */
       sourceType?: Array<keyof sourceType>
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
@@ -161,7 +159,6 @@ declare module '../../index' {
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
       /** 用来上传的input元素ID（仅h5端
-       * @supported h5
        */
       imageId?: string
     }
@@ -198,11 +195,9 @@ declare module '../../index' {
       /** 本地临时文件大小，单位 B */
       size: number
       /** 文件的 MIME 类型
-       * @supported h5
        */
       type?: string
       /** 原始的浏览器 File 对象
-       * @supported h5
        */
       originalFileObj?: File
     }
@@ -324,7 +319,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 保存图片到系统相册。需要[用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) scope.writePhotosAlbum
-     * @supported weapp, alipay, swan, tt, h5, rn, harmony_hybrid
+     * @supported weapp
      * @example
      * ```tsx
      * Taro.saveImageToPhotosAlbum({
@@ -348,7 +343,7 @@ declare module '../../index' {
     previewMedia(option: previewMedia.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 在新页面中全屏预览图片。预览的过程中用户可以进行保存图片、发送给朋友等操作。
-     * @supported weapp, alipay, swan, tt, h5, rn, harmony_hybrid
+     * @supported weapp
      * @example
      * ```tsx
      * Taro.previewImage({
@@ -361,7 +356,7 @@ declare module '../../index' {
     previewImage(option: previewImage.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 获取图片信息。网络图片需先配置download域名才能生效。
-     * @supported weapp, alipay, swan, tt, h5, rn, harmony, harmony_hybrid
+     * @supported weapp
      * @example
      * ```tsx
      * Taro.getImageInfo({
@@ -400,7 +395,7 @@ declare module '../../index' {
     editImage(option: editImage.Option): Promise<editImage.SuccessCallbackResult>
 
     /** 压缩图片接口，可选压缩质量
-     * @supported weapp, tt, rn
+     * @supported weapp
      * @example
      * ```tsx
      * Taro.compressImage({
@@ -431,7 +426,7 @@ declare module '../../index' {
 
     /**
      * 从本地相册选择图片或使用相机拍照。
-     * @supported weapp, alipay, swan, tt, h5, rn, harmony_hybrid
+     * @supported weapp
      * @example
      * ```tsx
      * Taro.chooseImage({

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

@@ -4,30 +4,30 @@ import Taro from '../../index'
 declare module '../../index' {
   /** `MapContext` 实例，可通过 [Taro.createMapContext](./createMapContext) 获取。
    * `MapContext` 通过 id 跟一个 map 组件绑定，操作对应的 map 组件。
-   * @supported weapp, tt
+   * @supported weapp
    * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.html
    */
   interface MapContext {
     /** 获取当前地图中心的经纬度。返回的是 gcj02 坐标系，可以用于 [Taro.openLocation()](/docs/apis/location/openLocation)
-     * @supported weapp, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.getCenterLocation.html
      */
     getCenterLocation(option?: MapContext.GetCenterLocationOption): Promise<MapContext.GetCenterLocationSuccessCallbackResult>
 
     /** 设置定位点图标，支持网络路径、本地路径、代码包路径
-     * @supported weapp, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.setLocMarkerIcon.html
      */
     setLocMarkerIcon(option?: MapContext.SetLocMarkerIconOption): Promise<TaroGeneral.CallbackResult>
 
     /** 将地图中心移置当前定位点，此时需设置地图组件 show-location 为true。
-     * @supported weapp, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.moveToLocation.html
      */
     moveToLocation(option: MapContext.MoveToLocationOption): Promise<TaroGeneral.CallbackResult>
 
     /** 平移marker，带动画
-     * @supported weapp, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.translateMarker.html
      */
     translateMarker(option: MapContext.TranslateMarkerOption): Promise<TaroGeneral.CallbackResult>
@@ -36,37 +36,37 @@ declare module '../../index' {
     moveAlong(object)
 
     /** 缩放视野展示所有经纬度
-     * @supported weapp, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.includePoints.html
      */
     includePoints(option: MapContext.IncludePointsOption): Promise<TaroGeneral.CallbackResult>
 
     /** 获取当前地图的视野范围
-     * @supported weapp, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.getRegion.html
      */
     getRegion(option?: MapContext.GetRegionOption): Promise<MapContext.GetRegionSuccessCallbackResult>
 
     /** 获取当前地图的旋转角
-     * @supported weapp, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.getRotate.html
      */
     getRotate(option?: MapContext.GetRotateOption): Promise<MapContext.GetRotateSuccessCallbackResult>
 
     /** 获取当前地图的倾斜角
-     * @supported weapp, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.getSkew.html
      */
     getSkew(option?: MapContext.GetSkewOption): Promise<MapContext.GetSkewSuccessCallbackResult>
 
     /** 获取当前地图的缩放级别
-     * @supported weapp, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.getScale.html
      */
     getScale(option?: MapContext.GetScaleOption): Promise<MapContext.GetScaleSuccessCallbackResult>
 
     /** 设置地图中心点偏移，向后向下为增长，屏幕比例范围(0.25~0.75)，默认偏移为[0.5, 0.5]
-     * @supported weapp, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.setCenterOffset.html
      */
     setCenterOffset(option: MapContext.SetCenterOffsetOption): Promise<TaroGeneral.CallbackResult>
@@ -84,7 +84,7 @@ declare module '../../index' {
     addCustomLayer(option: MapContext.AddCustomLayerOption): Promise<TaroGeneral.CallbackResult>
 
     /** 创建自定义图片图层，图片会随着地图缩放而缩放。
-     * @supported weapp, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.addGroundOverlay.html
      */
     addGroundOverlay(option: MapContext.AddGroundLayerOption): Promise<TaroGeneral.CallbackResult>
@@ -120,13 +120,13 @@ declare module '../../index' {
     setBoundary(option: MapContext.SetBoundaryOption): Promise<TaroGeneral.CallbackResult>
 
     /** 更新自定义图片图层。
-     * @supported weapp, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.updateGroundOverlay.html
      */
     updateGroundOverlay(option: MapContext.UpdateGroundOverlayOption): Promise<TaroGeneral.CallbackResult>
 
     /** 移除自定义图片图层。
-     * @supported weapp, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/map/MapContext.removeGroundOverlay.html
      */
     removeGroundOverlay(option: MapContext.RemoveGroundOverlayOption): Promise<TaroGeneral.CallbackResult>
@@ -621,7 +621,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 创建 [map](/docs/components/maps/map) 上下文 [MapContext](/docs/apis/media/map/MapContext) 对象。
-     * @supported weapp, tt
+     * @supported weapp
      * @example
      * ```tsx
      * const mapCtx = Taro.createMapContext('myMap')

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

@@ -155,7 +155,7 @@ declare module '../../index' {
    */
   interface RecorderManager {
     /** 监听录音错误事件
-     * @supported weapp, rn, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.onError.html
      */
     onError(
@@ -163,7 +163,7 @@ declare module '../../index' {
       callback: RecorderManager.OnErrorCallback,
     ): void
     /** 监听已录制完指定帧大小的文件事件。如果设置了 frameSize，则会回调此事件。
-     * @supported weapp, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.onFrameRecorded.html
      */
     onFrameRecorded(
@@ -187,7 +187,7 @@ declare module '../../index' {
       callback: (res: TaroGeneral.CallbackResult) => void,
     ): void
     /** 监听录音暂停事件
-     * @supported weapp, rn, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.onPause.html
      */
     onPause(
@@ -195,7 +195,7 @@ declare module '../../index' {
       callback: (res: TaroGeneral.CallbackResult) => void,
     ): void
     /** 监听录音继续事件
-     * @supported weapp, rn, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.onResume.html
      */
     onResume(
@@ -203,7 +203,7 @@ declare module '../../index' {
       callback: (res: TaroGeneral.CallbackResult) => void,
     ): void
     /** 监听录音开始事件
-     * @supported weapp, rn, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.onStart.html
      */
     onStart(
@@ -211,7 +211,7 @@ declare module '../../index' {
       callback: (res: TaroGeneral.CallbackResult) => void,
     ): void
     /** 监听录音结束事件
-     * @supported weapp, rn, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.onStop.html
      */
     onStop(
@@ -219,22 +219,22 @@ declare module '../../index' {
       callback: RecorderManager.OnStopCallback,
     ): void
     /** 暂停录音
-     * @supported weapp, rn
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.pause.html
      */
     pause(): void
     /** 继续录音
-     * @supported weapp, rn, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.resume.html
      */
     resume(): void
     /** 开始录音
-     * @supported weapp, rn, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.start.html
      */
     start(option: RecorderManager.StartOption): void
     /** 停止录音
-     * @supported weapp, rn, tt
+     * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/recorder/RecorderManager.stop.html
      */
     stop(): void
@@ -282,7 +282,7 @@ declare module '../../index' {
     startRecord(option: startRecord.Option): Promise<startRecord.SuccessCallbackResult>
 
     /** 获取**全局唯一**的录音管理器 RecorderManager
-     * @supported weapp, rn
+     * @supported weapp
      * @example
      * ```tsx
      * const recorderManager = Taro.getRecorderManager()