@uiw/react-amap-types - npm Package Compare versions

Comparing version 7.1.7 to 7.1.8

package.json

 {
   "name": "@uiw/react-amap-types",
-  "version": "7.1.7",
+  "version": "7.1.8",
   "description": "基于 React 封装的高德地图组件。AMap Component Based On React.",
@@ -5,0 +5,0 @@ "funding": "https://jaywcjlove.github.io/#/sponsor",

src/services.d.ts

@@ -252,2 +252,4 @@ /// <reference path="./base.d.ts" />
    * 根据输入关键字提示匹配信息，可将Poi类型和城市作为输入提示的限制条件。用户可以通过自定义回调函数取回并显
+   * 
+   * @see https://lbs.amap.com/api/javascript-api-v2/guide/services/autocomplete
    */
@@ -263,5 +265,23 @@ class AutoComplete extends MapEventListener<'choose' | 'select'> {
     /** 设置是否强制限制城市 */
-    search(keyword?: string, callback?: (status: 'complete' | 'error' | 'no_data', result?: AutoCompleteSearchCallback) => void): void;
+    search(keyword: string, callback: (status: 'complete' | 'error' | 'no_data', result: AutoCompleteSearchResult) => void): void;
   }
-  interface AutoCompleteSearchCallback {
+  interface Tip {
+    /** 名称 */
+    name: string;
+    /** 所属区域 */
+    district: string;
+    /** 区域编码 */
+    adcode: string;
+    /** 地址 */
+    address: string;
+    /** 城市 */
+    city: any[];
+    /** ID */
+    id: string;
+    /** 坐标经纬度 */
+    location: LngLat;
+    /** 类型编码 */
+    typecode: string;
+  }
+  interface AutoCompleteSearchResult {
     /** 查询状态说明 */
@@ -272,10 +292,3 @@ info: string;
     /** 输入提示列表 */
-    tips: Array<{
-      /** 名称 */
-      name: string;
-      /** 所属区域 */
-      district: string;
-      /** 区域编码 */
-      adcode: string;
-    }>
+    tips: Array<Tip>;
   }
@@ -287,4 +300,9 @@ interface AutoCompleteOptions {
     city?: string;
-    /** 返回的数据类型。可选值：all-返回所有数据类型、poi-返回POI数据类型、bus-返回公交站点数据类型、busline-返回公交线路数据类型目前暂时不支持多种类型 */
-    datatype?: string;
+    /** 返回的数据类型。可选值：
+     * - `all` 返回所有数据类型
+     * - `poi` 返回POI数据类型
+     * - `bus` 返回公交站点数据类型
+     * - `busline` 返回公交线路数据类型目前暂时不支持多种类型
+     */
+    datatype?: 'all' | 'bus' | 'poi' | 'busline';
     /** 是否强制限制在设置的城市内搜索,默认值为：false，true：强制限制设定城市，false：不强制限制设定城市 */
@@ -325,4 +343,4 @@ citylimit?: boolean;
   /**
-     * 根据输入关键字提示匹配信息，可将Poi类型和城市作为输入提示的限制条件。用户可以通过自定义回调函数取回并显
-     */
+   * 根据输入关键字提示匹配信息，可将Poi类型和城市作为输入提示的限制条件。用户可以通过自定义回调函数取回并显
+   */
   class Autocomplete extends MapEventListener<'choose' | 'select'> {
@@ -337,3 +355,3 @@ constructor(opts: AutoCompleteOptions);
     /** 设置是否强制限制城市 */
-    search(keyword?: string, callback?: (status: 'complete' | 'error' | 'no_data', result?: AutoCompleteSearchCallback) => void): void;
+    search(keyword: string, callback: (status: 'complete' | 'error' | 'no_data', result: AutoCompleteSearchResult) => void): void;
   }
@@ -340,0 +358,0 @@ /** 地点搜索服务插件，提供某一特定地区的位置查询服务。 */

No alert changes

Improved metrics

Total package byte prevSize

164508

0.21%

Lines of code

4159

0.43%

No dependency changes