@types/mapbox__mapbox-gl-geocoder
Advanced tools
@types/mapbox__mapbox-gl-geocoder - npm Package Compare versions
Comparing version 4.7.0 to 4.7.1
@@ -37,15 +37,15 @@ // Type definitions for @mapbox/mapbox-gl-geocoder 4.7 | ||
| */ | ||
| 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?: mapboxgl.Map | 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; | ||
| /** | ||
@@ -56,23 +56,23 @@ * If `false`, animating the map to a selected result is disabled. If `true`, animating the map will use the default animation parameters. | ||
| */ | ||
| 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; | ||
| /** | ||
@@ -82,19 +82,19 @@ * a bounding box argument: this is a bounding box given as an array in the format [minX, minY, maxX, maxY]. | ||
| */ | ||
| 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; | ||
| /** | ||
@@ -105,3 +105,3 @@ * Specify the language to use for response text and query result weighting. | ||
| */ | ||
| language?: string; | ||
| language?: string | undefined; | ||
| /** | ||
@@ -112,3 +112,3 @@ * A function which accepts a Feature in the [Carmen GeoJSON](https://github.com/mapbox/carmen/blob/master/carmen-geojson.md) | ||
| */ | ||
| filter?: (feature: Result) => boolean; | ||
| filter?: ((feature: Result) => boolean) | undefined; | ||
| /** | ||
@@ -118,6 +118,6 @@ * A function accepting the query string and current features list which performs geocoding to supplement results from the Mapbox Geocoding API. | ||
| */ | ||
| externalGeocoder?: ( | ||
| externalGeocoder?: (( | ||
| searchInput: string, | ||
| features: GeoJSON.FeatureCollection<GeoJSON.Geometry>, | ||
| ) => Promise<GeoJSON.FeatureCollection>; | ||
| ) => Promise<GeoJSON.FeatureCollection>) | undefined; | ||
| /** | ||
@@ -127,7 +127,7 @@ * 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. | ||
| */ | ||
| reverseGeocode?: boolean; | ||
| reverseGeocode?: boolean | undefined; | ||
| /** | ||
| * Allow Mapbox to collect anonymous usage statistics from the plugin. (optional, default true) | ||
| */ | ||
| enableEventLogging?: boolean; | ||
| enableEventLogging?: boolean | undefined; | ||
| /** | ||
@@ -138,3 +138,3 @@ * 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. | ||
| */ | ||
| marker?: boolean | mapboxgl.Marker; | ||
| marker?: boolean | mapboxgl.Marker | undefined; | ||
| /** | ||
@@ -145,3 +145,3 @@ * A function that specifies how the results should be rendered in the dropdown menu. | ||
| */ | ||
| render?: (feature: Result) => string; | ||
| render?: ((feature: Result) => string) | undefined; | ||
| /** | ||
@@ -152,3 +152,3 @@ * A function that specifies how the selected result should be rendered in the search bar. | ||
| */ | ||
| getItemValue?: (feature: Result) => string; | ||
| getItemValue?: ((feature: Result) => string) | undefined; | ||
| /** | ||
@@ -158,3 +158,3 @@ * A string specifying the geocoding [endpoint](https://docs.mapbox.com/api/search/#endpoints) to query. | ||
| */ | ||
| mode?: 'mapbox.places' | 'mapbox.places-permanent'; | ||
| mode?: 'mapbox.places' | 'mapbox.places-permanent' | undefined; | ||
| /** | ||
@@ -164,3 +164,3 @@ * A function accepting the query string which performs local geocoding to supplement results from the Mapbox Geocoding API. | ||
| */ | ||
| localGeocoder?: (query: string) => Result[]; | ||
| localGeocoder?: ((query: string) => Result[]) | undefined; | ||
| /** | ||
@@ -170,3 +170,3 @@ * If `true`, indicates that the `localGeocoder` results should be the only ones returned to the user. | ||
| */ | ||
| localGeocoderOnly?: boolean; | ||
| localGeocoderOnly?: boolean | undefined; | ||
| } | ||
@@ -173,0 +173,0 @@ } |
| { | ||
| "name": "@types/mapbox__mapbox-gl-geocoder", | ||
| "version": "4.7.0", | ||
| "version": "4.7.1", | ||
| "description": "TypeScript definitions for @mapbox/mapbox-gl-geocoder", | ||
| "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mapbox__mapbox-gl-geocoder", | ||
| "license": "MIT", | ||
@@ -30,4 +31,4 @@ "contributors": [ | ||
| }, | ||
| "typesPublisherContentHash": "47c579a0226d9dc0589847ab9620ad18aac494bf8bf0f2bdfa72d009477d01eb", | ||
| "typeScriptVersion": "3.4" | ||
| "typesPublisherContentHash": "87892f184b498653ffed45a9c9f6832eccc8162cc2b320199bf5b6e6def28538", | ||
| "typeScriptVersion": "3.6" | ||
| } |
@@ -11,3 +11,3 @@ # Installation | ||
| ### Additional Details | ||
| * Last updated: Wed, 03 Feb 2021 10:22:58 GMT | ||
| * Last updated: Thu, 08 Jul 2021 16:23:57 GMT | ||
| * Dependencies: [@types/mapbox-gl](https://npmjs.com/package/@types/mapbox-gl), [@types/geojson](https://npmjs.com/package/@types/geojson) | ||
@@ -14,0 +14,0 @@ * Global values: `MapboxGeocoder` |
New alerts
License Policy Violation
LicenseThis 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
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No website
QualityPackage does not have a website.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by2.74%
16391
- Number of low quality alerts
- decreased by-100%
0