@tarojs/taro 3.8.0-canary.0 → 4.0.0-beta.0

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

@@ -7,16 +7,23 @@ declare module '../../index' {
       latitude: number
       /** 经度，范围为-180~180，负数表示西经。使用 gcj02 国测局坐标系 */
       longitude: number
+      /** 缩放比例
+       * @weapp 范围 5~18，默认值18
+       * @alipay 范围 3~19，默认值15
+       */
+      scale?: number
+      /** 位置名 */
+      name?: string
       /** 地址的详细说明 */
       address?: string
+      /** 定义在拉起的地图 App 面板中需要被屏蔽的地图类 App
+       * @supported swan
+       */
+      ignoredApps?: Array<any>
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
-      /** 位置名 */
-      name?: string
-      /** 缩放比例，范围5~18 */
-      scale?: number
       /** 接口调用成功的回调函数 */
       success?: (res: TaroGeneral.CallbackResult) => void
     }
@@ -24,20 +31,32 @@ declare module '../../index' {
 
   namespace getLocation {
     interface Option {
-      /** 传入 true 会返回高度信息，由于获取高度需要较高精确度，会减慢接口返回速度 */
-      altitude?: string
+      /** 传入 true 会返回高度信息，由于获取高度需要较高精确度，会减慢接口返回速度
+       * @default false
+       */
+      altitude?: boolean
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
       /** 高精度定位超时时间(ms)，指定时间内返回最高精度，该值3000ms以上高精度定位才有效果 */
       highAccuracyExpireTime?: number
-      /** 开启高精度定位 */
+      /** 开启高精度定位
+       * @default false
+       */
       isHighAccuracy?: boolean
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
-      /** wgs84 返回 gps 坐标，gcj02 返回可用于 Taro.openLocation 的坐标 */
+      /** wgs84 返回 gps 坐标，gcj02 返回可用于 Taro.openLocation 的坐标
+       * @default "wgs84"
+       */
       type?: string
+      /** 针对 iOS14/Android12 及以上的新特性，其他情况本参数忽略。默认情况宿主是精确定位就返回精确定位信息。
+       * 传入 true 会强制使用精确定位信息，iOS14/Android12 及以上如果没有精确定位权限，会弹出精确定位授权弹框
+       * @supported swan
+       * @default false
+       */
+      needFullAccuracy?: boolean
     }
     interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 位置的精确度 */
@@ -54,6 +73,42 @@ declare module '../../index' {
       speed: number
       /** 垂直精度，单位 m（Android 无法获取，返回 0） */
       verticalAccuracy: number
+      /** 城市名称
+       * @supported swan
+       */
+      street?: string
+      /** 国家代码
+       * @supported swan
+       */
+      cityCode?: string
+      /** 城市名称
+       * @supported swan, tt
+       */
+      city?: string
+      /** 国家
+       * @supported swan
+       */
+      country?: string
+      /** 国家代码
+       * @supported swan
+       */
+      countryCode?: string
+      /** 省份
+       * @supported swan
+       */
+      province?: string
+      /** 街道号码
+       * @supported swan
+       */
+      streetNumber?: string
+      /** 区
+       * @supported swan
+       */
+      district?: string
+      /** 是不是精确定位信息
+       * @supported swan
+       */
+      isFullAccuracy?: boolean
       /** 调用结果 */
       errMsg: string
     }
@@ -97,6 +152,12 @@ declare module '../../index' {
        * @see https://lbs.qq.com/webApi/component/componentGuide/componentPicker
        */
       mapOpts?: Record<string, unknown>
+      /** 页面显示标题
+       * @supported alipay
+       * @alipay 安卓默认值为 位置，iOS、IDE 默认值为 你在哪里?
+       * @see https://opendocs.alipay.com/mini/api/location?pathHash=951b46a1
+       */
+      title?: string
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
       /** 接口调用失败的回调函数 */
@@ -114,6 +175,30 @@ declare module '../../index' {
       longitude: number
       /** 位置名称 */
       name: string
+      /** 区县代码
+       * @supported alipay
+       */
+      adCode?: number
+      /** 区县名称
+       * @supported alipay
+       */
+      adName?: string
+      /** 城市代码
+       * @supported alipay
+       */
+      cityCode?: string
+      /** 城市名称
+       * @supported alipay
+       */
+      cityName?: string
+      /** 省份代码
+       * @supported alipay
+       */
+      provinceCode?: number
+      /** 省份名称
+       * @supported alipay
+       */
+      provinceName?: string
       /** 调用结果 */
       errMsg: string
     }
@@ -132,6 +217,10 @@ declare module '../../index' {
 
   namespace startLocationUpdateBackground {
     interface Option {
+      /** wgs84 返回 gps 坐标，gcj02 返回可用于 wx.openLocation 的坐标
+       * @default "gcj02"
+       */
+      type?: string
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
@@ -143,6 +232,16 @@ declare module '../../index' {
 
   namespace startLocationUpdate {
     interface Option {
+      /** wgs84 返回 gps 坐标，gcj02 返回可用于 wx.openLocation 的坐标
+       * @default "gcj02"
+       */
+      type?: string
+      /** 针对 iOS14/Android12 及以上的新特性，其他情况本参数忽略。默认情况宿主是精确定位就返回精确定位信息。
+       * 传入 true 会强制使用精确定位信息，iOS14/Android12 及以上如果没有精确定位权限，会弹出精确定位授权弹框
+       * @supported swan
+       * @default false
+       */
+      needFullAccuracy?: boolean
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
@@ -161,6 +260,11 @@ declare module '../../index' {
     interface CallbackResult {
       /** 错误码 */
       errCode: number
+      /** 错误信息
+       * @supported tt
+       * @tt 最低支持版本 2.48.0
+       */
+      errMsg?: string
     }
   }
 
@@ -185,13 +289,50 @@ declare module '../../index' {
       speed: number
       /** 垂直精度，单位 m（Android 无法获取，返回 0） */
       verticalAccuracy: number
+      /** 街道名称
+       * @supported swan
+       */
+      street?: string
+      /** 城市编码
+       * @supported swan
+       */
+      cityCode?: string
+      /** 城市名称
+       * @supported swan, tt
+       * @tt iOS 不支持
+       */
+      city?: string
+      /** 国家
+       * @supported swan
+       */
+      country?: string
+      /** 国家代码
+       * @supported swan
+       */
+      countryCode?: string
+      /** 省份
+       * @supported swan
+       */
+      province?: string
+      /** 街道号码
+       * @supported swan
+       */
+      streetNumber?: string
+      /** 区
+       * @supported swan
+       */
+      district?: string
+      /** 是不是精确定位信息
+       * @supported swan
+       */
+      isFullAccuracy?: boolean
     }
   }
 
   namespace getFuzzyLocation {
     interface Option {
       /** wgs84 返回 gps 坐标，gcj02 返回可用于 Taro.openLocation 的坐标 */
-      type?: 'wgs84' | 'gcj02'
+      type?: keyof Type
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
@@ -200,6 +341,13 @@ declare module '../../index' {
       success?: (result: SuccessCallbackResult) => void
     }
 
+    interface Type {
+      /** 返回 gps 坐标 */
+      wgs84
+      /** 返回 gcj02 坐标*/
+      gcj02
+    }
+
     interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 纬度，范围为 -90~90，负数表示南纬 */
       latitude: number
@@ -210,7 +358,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 关闭监听实时位置变化，前后台都停止消息接收
-     * @supported weapp, rn, tt
+     * @supported weapp, swan, tt, rn
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.stopLocationUpdate.html
      */
     stopLocationUpdate(option?: stopLocationUpdate.Option): void
@@ -232,13 +380,13 @@ declare module '../../index' {
      *
      * **注意**
      * - 获取位置信息需配置[地理位置用途说明](https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#permission)。
-     * @supported weapp, rn, tt
+     * @supported weapp, swan, tt, rn
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.startLocationUpdate.html
      */
     startLocationUpdate(option?: startLocationUpdate.Option): void
 
     /** 使用微信内置地图查看位置
-     * @supported weapp, h5, tt
+     * @supported weapp, alipay, swan, jd, tt, h5
      * @example
      * ```tsx
      * Taro.getLocation({
@@ -268,7 +416,7 @@ declare module '../../index' {
     ): void
 
     /** 监听实时地理位置变化事件，需结合 Taro.startLocationUpdateBackground、Taro.startLocationUpdate 使用。
-     * @supported weapp, rn, tt
+     * @supported weapp, swan, tt, rn
      * @example
      * ```tsx
      * const _locationChangeFn = function (res) {
@@ -290,16 +438,16 @@ declare module '../../index' {
      */
     offLocationChangeError(
       /** 监听持续定位接口返回失败时触发的回调函数 */
-      callback: onLocationChangeError.Callback,
+      callback?: onLocationChangeError.Callback,
     ): void
 
     /** 取消监听实时地理位置变化事件
-     * @supported weapp, rn, tt
+     * @supported weapp, swan, tt, rn
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.offLocationChange.html
      */
     offLocationChange(
       /** 实时地理位置变化事件的回调函数 */
-      callback: (res: TaroGeneral.CallbackResult) => void,
+      callback?: onLocationChange.Callback,
     ): void
 
     /** 获取当前的地理位置、速度。当用户离开小程序后，此接口无法调用。开启高精度定位，接口耗时会增加，可指定 highAccuracyExpireTime 作为超时时间。
@@ -307,7 +455,7 @@ declare module '../../index' {
      * **注意**
      * - 工具中定位模拟使用IP定位，可能会有一定误差。且工具目前仅支持 gcj02 坐标。
      * - 使用第三方服务进行逆地址解析时，请确认第三方服务默认的坐标系，正确进行坐标转换。
-     * @supported weapp, rn, tt
+     * @supported weapp, swan, jd, qq, tt, rn
      * @example
      *  ```tsx
      * Taro.getLocation({
@@ -333,7 +481,7 @@ declare module '../../index' {
     /** 打开地图选择位置。
      *
      * `chooseLocation` api功能是依赖于腾讯位置服务，所以需要使用 api 密钥。如果您没有，可以前往腾讯位置服务[开发者控制台](https://lbs.qq.com/console/mykey.html?console=mykey)进行申请。
-     * @supported weapp, h5, tt
+     * @supported weapp, alipay, swan, jd, tt, h5
      * @example
      * ```tsx
      * // config/index.js

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

@@ -292,83 +292,83 @@ declare module '../../index' {
     /** 音频进入可以播放状态，但不保证后面可以流畅播放
      * @supported weapp, h5, rn
      */
-    onCanplay(callback?: () => void): void
+    onCanplay(callback?: InnerAudioContext.OnCanplayCallback): void
     /** 音频播放事件
      * @supported weapp, h5, rn
      */
-    onPlay(callback?: () => void): void
+    onPlay(callback?: InnerAudioContext.OnPlayCallback): void
     /** 音频暂停事件
      * @supported weapp, h5, rn
      */
-    onPause(callback?: () => void): void
+    onPause(callback?: InnerAudioContext.OnPauseCallback): void
     /** 音频停止事件
      * @supported weapp, h5, rn
      */
-    onStop(callback?: () => void): void
+    onStop(callback?: InnerAudioContext.OnStopCallback): void
     /** 音频自然播放结束事件
      * @supported weapp, h5, rn
      */
-    onEnded(callback?: () => void): void
+    onEnded(callback?: InnerAudioContext.OnEndedCallback): void
     /** 音频播放进度更新事件
      * @supported weapp, h5, rn
      */
-    onTimeUpdate(callback?: () => void): void
+    onTimeUpdate(callback?: InnerAudioContext.OnTimeUpdateCallback): void
     /** 音频播放错误事件
      * @supported weapp, h5, rn
      */
-    onError(callback?: (res: InnerAudioContext.onErrorDetail) => void): void
+    onError(callback?: InnerAudioContext.OnErrorCallback): void
     /** 音频加载中事件，当音频因为数据不足，需要停下来加载时会触发
      * @supported weapp, h5, rn
      */
-    onWaiting(callback?: () => void): void
+    onWaiting(callback?: InnerAudioContext.OnWaitingCallback): void
     /** 音频进行 seek 操作事件
      * @supported weapp, h5, rn
      */
-    onSeeking(callback?: () => void): void
+    onSeeking(callback?: InnerAudioContext.OnSeekingCallback): void
     /** 音频完成 seek 操作事件
      * @supported weapp, h5, rn
      */
-    onSeeked(callback?: () => void): void
-    /** 取消监听 onCanplay 事件
+    onSeeked(callback?: InnerAudioContext.OnSeekedCallback): void
+    /** 取消监听 canplay 事件
      * @supported weapp, h5, rn
      */
-    offCanplay(callback?: () => void): void
-    /** 取消监听 onPlay 事件
+    offCanplay(callback?: InnerAudioContext.OnCanplayCallback): void
+    /** 取消监听 play 事件
      * @supported weapp, h5, rn
      */
-    offPlay(callback?: () => void): void
-    /** 取消监听 onPause 事件
+    offPlay(callback?: InnerAudioContext.OnPlayCallback): void
+    /** 取消监听 pause 事件
      * @supported weapp, h5, rn
      */
-    offPause(callback?: () => void): void
-    /** 取消监听 onStop 事件
+    offPause(callback?: InnerAudioContext.OnPauseCallback): void
+    /** 取消监听 stop 事件
      * @supported weapp, h5, rn
      */
-    offStop(callback?: () => void): void
-    /** 取消监听 onEnded 事件
+    offStop(callback?: InnerAudioContext.OnStopCallback): void
+    /** 取消监听 ended 事件
      * @supported weapp, h5, rn
      */
-    offEnded(callback?: () => void): void
-    /** 取消监听 onTimeUpdate 事件
+    offEnded(callback?: InnerAudioContext.OnEndedCallback): void
+    /** 取消监听 timeUpdate 事件
      * @supported weapp, h5, rn
      */
-    offTimeUpdate(callback?: () => void): void
-    /** 取消监听 onError 事件
+    offTimeUpdate(callback?: InnerAudioContext.OnTimeUpdateCallback): void
+    /** 取消监听 error 事件
      * @supported weapp, h5, rn
      */
-    offError(callback?: () => void): void
-    /** 取消监听 onWaiting 事件
+    offError(callback?: InnerAudioContext.OnErrorCallback): void
+    /** 取消监听 waiting 事件
      * @supported weapp, h5, rn
      */
-    offWaiting(callback?: () => void): void
-    /** 取消监听 onSeeking 事件
+    offWaiting(callback?: InnerAudioContext.OnWaitingCallback): void
+    /** 取消监听 seeking 事件
      * @supported weapp, h5, rn
      */
-    offSeeking(callback?: () => void): void
-    /** 取消监听 onSeeked 事件
+    offSeeking(callback?: InnerAudioContext.OnSeekingCallback): void
+    /** 取消监听 seeked 事件
      * @supported weapp, h5, rn
      */
-    offSeeked(callback?: () => void): void
+    offSeeked(callback?: InnerAudioContext.OnSeekedCallback): void
   }
 
   namespace InnerAudioContext {
@@ -391,6 +391,26 @@ declare module '../../index' {
       /** 未知错误 */
       '-1'
     }
+    /** 音频进入可以播放状态事件的回调函数 */
+    type OnCanplayCallback = (res: Partial<TaroGeneral.CallbackResult>) => void
+    /** 音频播放事件的回调函数 */
+    type OnPlayCallback = (res: Partial<TaroGeneral.CallbackResult>) => void
+    /** 音频暂停事件的回调函数 */
+    type OnPauseCallback = (res: Partial<TaroGeneral.CallbackResult>) => void
+    /** 音频停止事件的回调函数 */
+    type OnStopCallback = (res: Partial<TaroGeneral.CallbackResult>) => void
+    /** 音频自然播放结束事件的回调函数 */
+    type OnEndedCallback = (res: Partial<TaroGeneral.CallbackResult>) => void
+    /** 音频播放进度更新事件的回调函数 */
+    type OnTimeUpdateCallback = (res: Partial<TaroGeneral.CallbackResult>) => void
+    /** 音频播放错误事件的回调函数 */
+    type OnErrorCallback = (res: onErrorDetail) => void
+    /** 音频加载中事件的回调函数 */
+    type OnWaitingCallback = (res: Partial<TaroGeneral.CallbackResult>) => void
+    /** 音频进行 seek 操作事件的回调函数 */
+    type OnSeekingCallback = (res: Partial<TaroGeneral.CallbackResult>) => void
+    /** 音频完成 seek 操作事件的回调函数 */
+    type OnSeekedCallback = (res: Partial<TaroGeneral.CallbackResult>) => void
   }
 
   /** MediaAudioPlayer 实例，可通过 [Taro.createMediaAudioPlayer](./createMediaAudioPlayer) 接口获取实例。

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

@@ -90,15 +90,15 @@ declare module '../../index' {
        * @supported alipay
        */
       height: string
-       /** 视频文件的宽度。
+      /** 视频文件的宽度。
        * @supported alipay
        */
       width: string
-       /** 视频文件的尺寸。
+      /** 视频文件的尺寸。
        * @supported alipay
        */
       size: string
-       /** 录制的持续时间。
+      /** 录制的持续时间。
        * @supported alipay
        */
       duration: string
@@ -152,6 +152,8 @@ declare module '../../index' {
       normal
       /** 低质量 */
       low
+      /** 原图 */
+      original
     }
   }
 
@@ -192,6 +194,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 创建 camera 上下文 CameraContext 对象。
+     * @alipay 支付宝小程序需指定 camera 组件中的 id 属性
      * @supported weapp, rn, tt, alipay
      * @example
      * ```tsx

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

@@ -361,7 +361,7 @@ declare module '../../index' {
     previewImage(option: previewImage.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 获取图片信息。网络图片需先配置download域名才能生效。
-     * @supported weapp, alipay, swan, tt, h5, rn
+     * @supported weapp, alipay, swan, tt, h5, rn, harmony
      * @example
      * ```tsx
      * Taro.getImageInfo({

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

@@ -17,6 +17,8 @@ declare module '../../index' {
       verify?: keyof Verify
       /** 不 reLaunch 目标小程序，直接打开目标跳转的小程序退后台时的页面，需满足以下条件：1. 目标跳转的小程序生命周期未被销毁；2. 且目标当次启动的path、query、apiCategory与上次启动相同。默认值为 false 。 */
       noRelaunchIfPathUnchanged?: boolean
+      /** 打开的小程序是否支持全屏 */
+      allowFullScreen?: boolean
       /** 接口调用成功的回调函数 */
       success?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */

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

@@ -57,14 +57,6 @@ declare module '../../index' {
   }
 
   namespace DownloadTask {
-    /** HTTP Response Header 事件的回调函数 */
-    type OffHeadersReceivedCallback = (
-      res: TaroGeneral.CallbackResult,
-    ) => void
-    /** 下载进度变化事件的回调函数 */
-    type OffProgressUpdateCallback = (
-        res: TaroGeneral.CallbackResult,
-    ) => void
     /** HTTP Response Header 事件的回调函数 */
     type OnHeadersReceivedCallback = (
         result: OnHeadersReceivedCallbackResult,
@@ -135,7 +127,7 @@ declare module '../../index' {
      */
     offProgressUpdate(
       /** 下载进度变化事件的回调函数 */
-      callback: DownloadTask.OffProgressUpdateCallback,
+      callback: DownloadTask.OnProgressUpdateCallback,
     ): void
     /** 监听 HTTP Response Header 事件。会比请求完成事件更早
      * @supported weapp, h5
@@ -151,7 +143,7 @@ declare module '../../index' {
      */
     offHeadersReceived(
       /** HTTP Response Header 事件的回调函数 */
-      callback: DownloadTask.OffHeadersReceivedCallback,
+      callback: DownloadTask.OnHeadersReceivedCallback,
     ): void
   }
 

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

@@ -400,7 +400,7 @@ declare module '../../index' {
      * - 对于 `GET` 方法的数据，会将数据转换成 query string（`encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...`）
      * - 对于 `POST` 方法且 `header['content-type']` 为 `application/json` 的数据，会对数据进行 JSON 序列化
      * - 对于 `POST` 方法且 `header['content-type']` 为 `application/x-www-form-urlencoded` 的数据，会将数据转换成 query string `（encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...）`
-     * @supported weapp, h5, rn, alipay, swan, tt, qq
+     * @supported weapp, h5, rn, alipay, swan, tt, qq, harmony
      * @example
      * ```tsx
      * Taro.request({

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

@@ -56,14 +56,6 @@ declare module '../../index' {
   }
 
   namespace UploadTask {
-    /** HTTP Response Header 事件的回调函数 */
-    type OffHeadersReceivedCallback = (
-      res: TaroGeneral.CallbackResult,
-    ) => void
-    /** 上传进度变化事件的回调函数 */
-    type OffProgressUpdateCallback = (
-      res: TaroGeneral.CallbackResult,
-    ) => void
     /** HTTP Response Header 事件的回调函数 */
     type OnHeadersReceivedCallback = (
       result: OnHeadersReceivedCallbackResult,
@@ -138,7 +130,7 @@ declare module '../../index' {
      */
     offProgressUpdate(
       /** 上传进度变化事件的回调函数 */
-      callback: UploadTask.OffProgressUpdateCallback,
+      callback: UploadTask.OnProgressUpdateCallback,
     ): void
     /** 监听 HTTP Response Header 事件。会比请求完成事件更早
      * @supported weapp, h5
@@ -154,7 +146,7 @@ declare module '../../index' {
      */
     offHeadersReceived(
       /** HTTP Response Header 事件的回调函数 */
-      callback: UploadTask.OffHeadersReceivedCallback,
+      callback: UploadTask.OnHeadersReceivedCallback,
     ): void
   }
 

package/types/api/open-api/device-voip.d.ts

@@ -20,7 +20,7 @@ declare module '../../index' {
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
-      success?: (result: SuccessCallbackResult) => void
+      success?: (result: TaroGeneral.CallbackResult) => void
     }
   }
 
@@ -60,4 +60,4 @@ declare module '../../index' {
      */
     getDeviceVoIPList(option: getDeviceVoIPList.Option): Promise<getDeviceVoIPList.SuccessCallbackResult>
   }
-}
+}

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

@@ -81,7 +81,7 @@ declare module '../../index' {
      *
      * 通过 Taro.login 接口获得的用户登录态拥有一定的时效性。用户越久未使用小程序，用户登录态越有可能失效。反之如果用户一直在使用小程序，则用户登录态一直保持有效。具体时效逻辑由微信维护，对开发者透明。开发者只需要调用 Taro.checkSession 接口检测当前用户登录态是否有效。
      *
-     * 登录态过期后开发者可以再调用 Taro.login 获取新的用户登录态。调用成功说明当前 session_key 未过期，调用失败说明 session_key 已过期。更多使用方法详见 [小程序登录](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/login.html)。
+     * 登录态过期后开发者可以再调用 Taro.login 获取新的用户登录态。调用 Taro.checkSession 成功说明当前 session_key 未过期，调用失败说明 session_key 已过期。更多使用方法详见 [小程序登录](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/login.html)。
      * @supported weapp
      * @example
      * ```tsx

package/types/api/open-api/my-miniprogram.d.ts

@@ -8,7 +8,7 @@ declare module '../../index' {
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
-      success?: (res: TaroGeneral.CallbackResult) => void
+      success?: (res: SuccessCallbackResult) => void
     }
 
     interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
@@ -23,6 +23,6 @@ declare module '../../index' {
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/my-miniprogram/wx.checkIsAddedToMyMiniProgram.html
      */
-    checkIsAddedToMyMiniProgram(option?: checkIsAddedToMyMiniProgram.Option):Promise<checkIsAddedToMyMiniProgram.SuccessCallbackResult>
+    checkIsAddedToMyMiniProgram(option?: checkIsAddedToMyMiniProgram.Option): void
   }
 }