@tarojs/taro 3.4.1 → 3.4.2

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

@@ -59,6 +59,32 @@ declare module '../../index' {
     }
   }
 
+  namespace choosePoi {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 选择城市时，值为 1，选择精确位置时，值为 2 */
+      type: number
+      /** 城市名称 */
+      city: number
+      /** 位置名称 */
+      name: string
+      /** 详细地址 */
+      address: string
+      /** 纬度，浮点数，范围为-90~90，负数表示南纬。使用 gcj02 国测局坐标系 */
+      latitude: string
+      /** 经度，浮点数，范围为-180~180，负数表示西经。使用 gcj02 国测局坐标系 */
+      longitude: string
+    }
+  }
+
   namespace chooseLocation {
     interface Option {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
@@ -120,6 +146,18 @@ declare module '../../index' {
     }
   }
 
+  namespace onLocationChangeError {
+    /** 监听持续定位接口返回失败时触发的回调函数 */
+    type Callback = (
+      result: CallbackResult,
+    ) => void
+
+    interface CallbackResult {
+      /** 错误码 */
+      errCode: number
+    }
+  }
+
   namespace onLocationChange {
     /** 实时地理位置变化事件的回调函数 */
     type Callback = (
@@ -145,6 +183,34 @@ declare module '../../index' {
   }
 
   interface TaroStatic {
+    /** 关闭监听实时位置变化，前后台都停止消息接收
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.stopLocationUpdate.html
+     */
+    stopLocationUpdate(option?: stopLocationUpdate.Option): void
+
+    /** 开启小程序进入前后台时均接收位置消息，需引导用户开启[授权](./apis/open-api/authorize/authorize.md#后台定位)。授权以后，小程序在运行中或进入后台均可接受位置消息变化。
+     *
+     * **注意**
+     * - 安卓微信7.0.6版本，iOS 7.0.5版本起支持该接口
+     * - 需在app.json中配置requiredBackgroundModes: ['location']后使用
+     * - 获取位置信息需配置[地理位置用途说明](https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#permission)。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.startLocationUpdateBackground.html
+     */
+    startLocationUpdateBackground(
+      option?: startLocationUpdateBackground.Option,
+    ): void
+
+    /** 开启小程序进入前台时接收位置消息
+     *
+     * **注意**
+     * - 获取位置信息需配置[地理位置用途说明](https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#permission)。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.startLocationUpdate.html
+     */
+    startLocationUpdate(option?: startLocationUpdate.Option): void
+
     /** 使用微信内置地图查看位置
      * @supported weapp, h5
      * @example
@@ -166,6 +232,50 @@ declare module '../../index' {
      */
     openLocation(option: openLocation.Option): Promise<TaroGeneral.CallbackResult>
 
+    /** 监听持续定位接口返回失败时触发
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.onLocationChangeError.html
+     */
+    onLocationChangeError(
+      /** 监听持续定位接口返回失败时触发的回调函数 */
+      callback: onLocationChangeError.Callback,
+    ): void
+
+    /** 监听实时地理位置变化事件，需结合 Taro.startLocationUpdateBackground、Taro.startLocationUpdate 使用。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * const _locationChangeFn = function (res) {
+     *  console.log('location change', res)
+     * }
+     * Taro.onLocationChange(_locationChangeFn)
+     * Taro.offLocationChange(_locationChangeFn)
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.onLocationChange.html
+     */
+    onLocationChange(
+      /** 实时地理位置变化事件的回调函数 */
+      callback: onLocationChange.Callback,
+    ): void
+
+    /** 取消监听持续定位接口返回失败时触发
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.offLocationChangeError.html
+     */
+    offLocationChangeError(
+      /** 监听持续定位接口返回失败时触发的回调函数 */
+      callback: onLocationChangeError.Callback,
+    ): void
+
+    /** 取消监听实时地理位置变化事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.offLocationChange.html
+     */
+    offLocationChange(
+      /** 实时地理位置变化事件的回调函数 */
+      callback: (res: TaroGeneral.CallbackResult) => void,
+    ): void
+
     /** 获取当前的地理位置、速度。当用户离开小程序后，此接口无法调用。开启高精度定位，接口耗时会增加，可指定 highAccuracyExpireTime 作为超时时间。
      *
      * **注意**
@@ -188,12 +298,17 @@ declare module '../../index' {
      */
     getLocation(option: getLocation.Option): Promise<getLocation.SuccessCallbackResult>
 
+    /** 打开POI列表选择位置，支持模糊定位（精确到市）和精确定位混选。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.choosePoi.html
+     */
+    choosePoi(option: choosePoi.Option): Promise<choosePoi.SuccessCallbackResult>
+
     /** 打开地图选择位置。
      *
      * `chooseLocation` api功能是依赖于腾讯位置服务，所以需要使用 api 密钥。如果您没有，可以前往腾讯位置服务[开发者控制台](https://lbs.qq.com/console/mykey.html?console=mykey)进行申请。
      * @supported weapp, h5
      * @example
-     *
      * ```tsx
      * // config/index.js
      *
@@ -208,59 +323,5 @@ declare module '../../index' {
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.chooseLocation.html
      */
     chooseLocation(option: chooseLocation.Option): Promise<chooseLocation.SuccessCallbackResult>
-
-    /** 关闭监听实时位置变化，前后台都停止消息接收
-     * @supported weapp
-     * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.stopLocationUpdate.html
-     */
-    stopLocationUpdate(option?: stopLocationUpdate.Option): void
-
-    /** 开启小程序进入前后台时均接收位置消息，需引导用户开启[授权]((open-ability/authorize#后台定位))。授权以后，小程序在运行中或进入后台均可接受位置消息变化。
-     *
-     * **注意**
-     * - 安卓微信7.0.6版本，iOS 7.0.5版本起支持该接口
-     * - 需在app.json中配置requiredBackgroundModes: ['location']后使用
-     * - 获取位置信息需配置[地理位置用途说明](https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#permission)。
-     * @supported weapp
-     * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.startLocationUpdateBackground.html
-     */
-    startLocationUpdateBackground(
-      option?: startLocationUpdateBackground.Option,
-    ): void
-
-    /** 开启小程序进入前台时接收位置消息
-     *
-     * **注意**
-     * - 获取位置信息需配置[地理位置用途说明](https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#permission)。
-     * @supported weapp
-     * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.startLocationUpdate.html
-     */
-    startLocationUpdate(option?: startLocationUpdate.Option): void
-
-    /** 监听实时地理位置变化事件，需结合 Taro.startLocationUpdateBackground、Taro.startLocationUpdate 使用。
-     * @supported weapp
-     * @example
-     * ```tsx
-     * const _locationChangeFn = function (res) {
-     *  console.log('location change', res)
-     * }
-     * Taro.onLocationChange(_locationChangeFn)
-     * Taro.offLocationChange(_locationChangeFn)
-     * ```
-     * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.onLocationChange.html
-     */
-    onLocationChange(
-      /** 实时地理位置变化事件的回调函数 */
-      callback: onLocationChange.Callback,
-    ): void
-
-    /** 取消监听实时地理位置变化事件
-     * @supported weapp
-     * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.offLocationChange.html
-     */
-    offLocationChange(
-      /** 实时地理位置变化事件的回调函数 */
-      callback: (res: TaroGeneral.CallbackResult) => void,
-    ): void
   }
 }