@types/mapbox__mapbox-gl-geocoder 4.7.0 → 4.7.3

mapbox__mapbox-gl-geocoder/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for @mapbox/mapbox-gl-geocoder (https://g
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mapbox__mapbox-gl-geocoder.
 
 ### Additional Details
- * Last updated: Wed, 03 Feb 2021 10:22:58 GMT
+ * Last updated: Mon, 15 Aug 2022 21:02:37 GMT
  * Dependencies: [@types/mapbox-gl](https://npmjs.com/package/@types/mapbox-gl), [@types/geojson](https://npmjs.com/package/@types/geojson)
  * Global values: `MapboxGeocoder`
 

mapbox__mapbox-gl-geocoder/index.d.ts

@@ -4,8 +4,10 @@
 //                 Dmytro Gokun <https://github.com/dmytro-gokun>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
-/// <reference types="mapbox-gl" />
 /// <reference types="geojson" />
+
+import mapboxgl = require('mapbox-gl');
+
 export as namespace MapboxGeocoder;
 export = MapboxGeocoder;
 
@@ -34,128 +36,128 @@ declare namespace MapboxGeocoder {
         /**
          * Use to set a custom API origin. (optional, default "https://api.mapbox.com"
          */
-        origin?: string;
+        origin?: string | undefined;
         /**
          * A [mapbox-gl](https://github.com/mapbox/mapbox-gl-js) instance to use when creating [Markers](https://docs.mapbox.com/mapbox-gl-js/api/#marker). Required if `options.marker` is `true`.
          */
-        mapboxgl?: mapboxgl.Map;
+        mapboxgl?: typeof mapboxgl | undefined;
         /**
          * On geocoded result what zoom level should the map animate to when a bbox isn't found in the response. If a bbox is found the map will fit to the bbox. (optional, default 16)
          */
-        zoom?: number;
+        zoom?: number | undefined;
         /**
          * Override the default placeholder attribute value. (optional, default "Search")
          */
-        placeholder?: string;
+        placeholder?: string | undefined;
         /**
          * If `false`, animating the map to a selected result is disabled. If `true`, animating the map will use the default animation parameters.
          * If an object, it will be passed as `options` to the map [`flyTo`](https://docs.mapbox.com/mapbox-gl-js/api/#map#flyto)
          * or [`fitBounds`](https://docs.mapbox.com/mapbox-gl-js/api/#map#fitbounds) method providing control over the animation of the transition. (optional, default true)
          */
-        flyTo?: boolean | mapboxgl.FlyToOptions | mapboxgl.FitBoundsOptions;
+        flyTo?: boolean | mapboxgl.FlyToOptions | mapboxgl.FitBoundsOptions | undefined;
         /**
          * 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.
          */
-        proximity?: LngLatLiteral;
+        proximity?: LngLatLiteral | undefined;
         /**
          * If `true`, the geocoder proximity will automatically update based on the map view. (optional, default true)
          */
-        trackProximity?: boolean;
+        trackProximity?: boolean | undefined;
         /**
          * If `true`, the geocoder control will collapse until hovered or in focus. (optional, default false)
          */
-        collapsed?: boolean;
+        collapsed?: boolean | undefined;
         /**
          * If `true`, the geocoder control will clear it's contents and blur when user presses the escape key. (optional, default false)
          */
-        clearAndBlurOnEsc?: boolean;
+        clearAndBlurOnEsc?: boolean | undefined;
         /**
          * If `true`, the geocoder control will clear its value when the input blurs. (optional, default false)
          */
-        clearOnBlur?: boolean;
+        clearOnBlur?: boolean | undefined;
         /**
          * a bounding box argument: this is a bounding box given as an array in the format [minX, minY, maxX, maxY].
          * Search results will be limited to the bounding box.
          */
-        bbox?: Bbox;
+        bbox?: Bbox | 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.
          */
-        types?: string;
+        types?: string | undefined;
         /**
          * a comma separated list of country codes to limit results to specified country or countries.
          */
-        countries?: string;
+        countries?: string | undefined;
         /**
          * Minimum number of characters to enter before results are shown. (optional, default 2)
          */
-        minLength?: number;
+        minLength?: number | undefined;
         /**
          * Maximum number of results to show. (optional, default 5)
          */
-        limit?: number;
+        limit?: number | undefined;
         /**
          * Specify the language to use for response text and query result weighting.
          * Options are IETF language tags comprised of a mandatory ISO 639-1 language code and optionally one or more IETF subtags for country or script.
          * More than one value can also be specified, separated by commas. Defaults to the browser's language settings.
          */
-        language?: string;
+        language?: string | undefined;
         /**
          * A function which accepts a Feature in the [Carmen GeoJSON](https://github.com/mapbox/carmen/blob/master/carmen-geojson.md)
          * format to filter out results from the Geocoding API response before they are included in the suggestions list.
          * Return `true` to keep the item, `false` otherwise.
          */
-        filter?: (feature: Result) => boolean;
+        filter?: ((feature: Result) => boolean) | undefined;
         /**
          * A function accepting the query string and current features list which performs geocoding to supplement results from the Mapbox Geocoding API.
          * Expected to return a Promise which resolves to an Array of GeoJSON Features in the [Carmen GeoJSON](https://github.com/mapbox/carmen/blob/master/carmen-geojson.md) format.
          */
-        externalGeocoder?: (
+        externalGeocoder?: ((
             searchInput: string,
             features: GeoJSON.FeatureCollection<GeoJSON.Geometry>,
-        ) => Promise<GeoJSON.FeatureCollection>;
+        ) => Promise<GeoJSON.FeatureCollection>) | undefined;
         /**
          * If `true`, enable reverse geocoding mode. In reverse geocoding, search input is expected to be coordinates in the form `lat, lon`, with suggestions being the reverse geocodes.
          * (optional, default false)
          */
-        reverseGeocode?: boolean;
+        reverseGeocode?: boolean | undefined;
         /**
          * Allow Mapbox to collect anonymous usage statistics from the plugin. (optional, default true)
          */
-        enableEventLogging?: boolean;
+        enableEventLogging?: boolean | 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.
          * If the value is an object, the marker will be constructed using these options. If `false`, no marker will be added to the map.
          * Requires that `options.mapboxgl` also be set. (optional, default true)
          */
-        marker?: boolean | mapboxgl.Marker;
+        marker?: boolean | mapboxgl.Marker | undefined;
         /**
          * A function that specifies how the results should be rendered in the dropdown menu.
          * This function should accepts a single [Carmen GeoJSON](https://github.com/mapbox/carmen/blob/master/carmen-geojson.md)
          * object as input and return a string. Any HTML in the returned string will be rendered.
          */
-        render?: (feature: Result) => string;
+        render?: ((feature: Result) => string) | undefined;
         /**
          * A function that specifies how the selected result should be rendered in the search bar.
          * This function should accept a single [Carmen GeoJSON](https://github.com/mapbox/carmen/blob/master/carmen-geojson.md) object as input and return a string.
          * HTML tags in the output string will not be rendered. Defaults to `(item) => item.place_name`.
          */
-        getItemValue?: (feature: Result) => string;
+        getItemValue?: ((feature: Result) => string) | undefined;
         /**
          *  A string specifying the geocoding [endpoint](https://docs.mapbox.com/api/search/#endpoints) to query.
          * Options are `mapbox.places` and `mapbox.places`. The `mapbox.places-permanent` mode requires an enterprise license for permanent geocodes. (optional, default "mapbox.places")
          */
-        mode?: 'mapbox.places' | 'mapbox.places-permanent';
+        mode?: 'mapbox.places' | 'mapbox.places-permanent' | undefined;
         /**
          * A function accepting the query string which performs local geocoding to supplement results from the Mapbox Geocoding API.
          * Expected to return an Array of GeoJSON Features in the [Carmen GeoJSON](https://github.com/mapbox/carmen/blob/master/carmen-geojson.md) format.
          */
-        localGeocoder?: (query: string) => Result[];
+        localGeocoder?: ((query: string) => Result[]) | undefined;
         /**
          * If `true`, indicates that the `localGeocoder` results should be the only ones returned to the user.
          * If `false`, indicates that the `localGeocoder` results should be combined with those from the Mapbox API with the `localGeocoder` results ranked higher. (optional, default false)
          */
-        localGeocoderOnly?: boolean;
+        localGeocoderOnly?: boolean | undefined;
     }
 }
 declare class MapboxGeocoder implements mapboxgl.IControl {
@@ -167,9 +169,8 @@ declare class MapboxGeocoder implements mapboxgl.IControl {
     /**
      * Clear and then focus the input.
      * [ev] the event that triggered the clear, if available
-     *
      */
-    clear(ev: Event): void;
+    clear(ev?: Event): void;
     /**
      * Set & query the input
      */

mapbox__mapbox-gl-geocoder/package.json

@@ -1,7 +1,8 @@
 {
     "name": "@types/mapbox__mapbox-gl-geocoder",
-    "version": "4.7.0",
+    "version": "4.7.3",
     "description": "TypeScript definitions for @mapbox/mapbox-gl-geocoder",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mapbox__mapbox-gl-geocoder",
     "license": "MIT",
     "contributors": [
         {
@@ -27,6 +28,6 @@
         "@types/geojson": "*",
         "@types/mapbox-gl": "*"
     },
-    "typesPublisherContentHash": "47c579a0226d9dc0589847ab9620ad18aac494bf8bf0f2bdfa72d009477d01eb",
-    "typeScriptVersion": "3.4"
+    "typesPublisherContentHash": "ac60019e648e6f3f2857ae2961b129400b9f4775a9bf2a22627453599256c68e",
+    "typeScriptVersion": "4.0"
 }