@types/mapbox__mapbox-gl-geocoder - npm Package Compare versions

Comparing version 4.7.7 to 5.0.0

mapbox__mapbox-gl-geocoder/index.d.ts

@@ -53,5 +53,5 @@ /// <reference types="geojson" />
         /**
-         * a proximity argument: this is a geographical point given as an object with latitude and longitude properties. Search results closer to this point will be given higher priority.
+         *  * @param {Object|'ip'} [options.proximity] a geographical point given as an object with `latitude` and `longitude` properties, or the string 'ip' to use a user's IP address location. Search results closer to this point will be given higher priority.
          */
-        proximity?: LngLatLiteral | undefined;
+        proximity?: LngLatLiteral | "ip" | undefined;
         /**
@@ -79,2 +79,6 @@ * If `true`, the geocoder proximity will automatically update based on the map view. (optional, default true)
         /**
+         * If `true`, search input coordinates for reverse geocoding is expected to be in the form `lon, lat` instead of the default `lat, lon`. (optional, default `false`)
+         */
+        flipCoordinates?: boolean | undefined;
+        /**
          * a comma seperated list of types that filter results to match those specified. See https://www.mapbox.com/developers/api/geocoding/#filter-type for available types.
@@ -127,2 +131,10 @@ */
         /**
+         * @param [options.enableGeolocation=false] If `true` enable user geolocation feature.
+         */
+        enableGeolocation?: boolean | undefined;
+        /**
+         * @param [options.addressAccuracy="street"] The accuracy for the geolocation feature with which we define the address line to fill. The browser API returns the user's position with accuracy, and sometimes we can get the neighbor's address. To prevent receiving an incorrect address, you can reduce the accuracy of the definition.
+         */
+        addressAccuracy?: "address" | "street" | "place" | "country" | undefined;
+        /**
          * If `true`, a [Marker](https://docs.mapbox.com/mapbox-gl-js/api/#marker) will be added to the map at the location of the user-selected result using a default set of Marker options.
@@ -188,4 +200,13 @@ * If the value is an object, the marker will be constructed using these options. If `false`, no marker will be added to the map.
     constructor(options?: MapboxGeocoder.GeocoderOptions);
+    /**
+     * The input element created by the geocoder's internal operations.
+     */
+    _inputEl?: HTMLInputElement;
     addTo(container: string | HTMLElement | mapboxgl.Map): this;
     onAdd(map: mapboxgl.Map): HTMLElement;
+    /**
+     * Set the accessToken option used for the geocoding request endpoint.
+     * @param {String} accessToken value
+     */
+    setAccessToken(accessToken: string): MapboxGeocoder;
     createIcon(name: string, path: any): SVGSVGElement;
@@ -204,9 +225,11 @@ onRemove(): this;
      * Set input
-     * searchInput location name or other search input
+     * @param {string} searchInput location name or other search input
+     * @param {boolean} [showSuggestions=false] display suggestion on setInput call
      */
-    setInput(searchInput: string): this;
+    setInput(searchInput: string, showSuggestions?: boolean): this;
     /**
-     * Set proximity The new `options.proximity` value. This is a geographical point given as an object with `latitude` and `longitude` properties.
+     * @param {Object|'ip'} proximity The new `options.proximity` value. This is a geographical point given as an object with `latitude` and `longitude` properties or the string 'ip'.
+     * @param {Boolean} disableTrackProximity If true, sets `trackProximity` to false. True by default to prevent `trackProximity` from unintentionally overriding an explicitly set proximity value.
      */
-    setProximity(proximity: MapboxGeocoder.LngLatLiteral): this;
+    setProximity(proximity: MapboxGeocoder.LngLatLiteral | "ip", disableTrackProximity?: boolean): this;
     /**
@@ -213,0 +236,0 @@ * Get the geocoder proximity

mapbox__mapbox-gl-geocoder/package.json

 {
     "name": "@types/mapbox__mapbox-gl-geocoder",
-    "version": "4.7.7",
+    "version": "5.0.0",
     "description": "TypeScript definitions for @mapbox/mapbox-gl-geocoder",
@@ -31,4 +31,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mapbox__mapbox-gl-geocoder",
     },
-    "typesPublisherContentHash": "e7980ad2255276a460c551943c97f49592f6d31595a9a3c634494ec6d84486df",
-    "typeScriptVersion": "4.5"
+    "typesPublisherContentHash": "21739ab482517596d877e1bc00c0db5b6904eac589b307784d597975fa222eba",
+    "typeScriptVersion": "4.6"
 }

mapbox__mapbox-gl-geocoder/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
+ * Last updated: Fri, 23 Feb 2024 22:35:27 GMT
  * Dependencies: [@types/geojson](https://npmjs.com/package/@types/geojson), [@types/mapbox-gl](https://npmjs.com/package/@types/mapbox-gl)
@@ -14,0 +14,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

19233

increased by9.38%

Lines of code

316

increased by8.22%

No dependency changes