Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add secondary_address to Geocoding v6 types #483

Merged
merged 1 commit into from
Apr 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Unreleased

## 0.15.6

- **Fix:** Add `secondary_address` to list of accepted types for Geocoding v6

## 0.15.5

- **Fix:** Rename directions api annotation option `max_speed` to `maxspeed` [#480](https://github.com/mapbox/mapbox-sdk-js/pull/480)
Expand Down
2 changes: 1 addition & 1 deletion docs/services.md
Original file line number Diff line number Diff line change
Expand Up @@ -2361,7 +2361,7 @@ See the [public documentation][264].
Each item in the array should be an [ISO 3166 alpha 2 country code][242].
\[OR] if used with input mode="structured" denotes single country in free form.
* `config.proximity` **([Coordinates][191] | `"ip"`)?** Bias local results based on a provided coordinate location or a user's IP address.
* `config.types` **[Array][216]<(`"street"` | `"country"` | `"region"` | `"postcode"` | `"district"` | `"place"` | `"locality"` | `"neighborhood"` | `"address"`)>?** Filter results by feature types.
* `config.types` **[Array][216]<(`"street"` | `"country"` | `"region"` | `"postcode"` | `"district"` | `"place"` | `"locality"` | `"neighborhood"` | `"address"` | `"secondary_address"`)>?** Filter results by feature types.
* `config.bbox` **[BoundingBox][192]?** Limit results to a bounding box.
* `config.limit` **[number][212]** Limit the number of results returned. (optional, default `5`)
* `config.format` **(`"geojson"` | `"v5"`)** Specify the desired response format of results (geojson, default) or for backwards compatibility (v5). (optional, default `'geojson'`)
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@mapbox/mapbox-sdk",
"version": "0.15.5",
"version": "0.15.6",
"description": "JS SDK for accessing Mapbox APIs",
"main": "index.js",
"files": [
Expand Down
6 changes: 3 additions & 3 deletions services/__tests__/geocoding-v6.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ describe('forwardGeocode', () => {
mode: 'standard',
countries: ['AO', 'AR'],
proximity: [3, 4],
types: ['street', 'country', 'region'],
types: ['street', 'country', 'region', 'address', 'secondary_address'],
autocomplete: true,
bbox: [1, 2, 3, 4],
format: 'v5',
Expand All @@ -53,7 +53,7 @@ describe('forwardGeocode', () => {
q: 'Tucson',
country: ['AO', 'AR'],
proximity: [3, 4],
types: ['street', 'country', 'region'],
types: ['street', 'country', 'region', 'address', 'secondary_address'],
autocomplete: 'true',
bbox: [1, 2, 3, 4],
format: 'v5',
Expand Down Expand Up @@ -153,7 +153,7 @@ describe('reverseGeocode', () => {
limit: 3,
language: 'de',
worldview: 'us',
permanent: 'true',
permanent: 'true'
}
});
});
Expand Down
7 changes: 4 additions & 3 deletions services/geocoding-v6.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ var featureTypes = [
'place',
'locality',
'neighborhood',
'address'
'address',
'secondary_address'
];

/**
Expand All @@ -38,7 +39,7 @@ var featureTypes = [
* Each item in the array should be an [ISO 3166 alpha 2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
* [OR] if used with input mode="structured" denotes single country in free form.
* @param {Coordinates|'ip'} [config.proximity] - Bias local results based on a provided coordinate location or a user's IP address.
* @param {Array<'street'|'country'|'region'|'postcode'|'district'|'place'|'locality'|'neighborhood'|'address'>} [config.types] - Filter results by feature types.
* @param {Array<'street'|'country'|'region'|'postcode'|'district'|'place'|'locality'|'neighborhood'|'address'|'secondary_address'>} [config.types] - Filter results by feature types.
* @param {BoundingBox} [config.bbox] - Limit results to a bounding box.
* @param {number} [config.limit=5] - Limit the number of results returned.
* @param {'geojson'|'v5'} [config.format='geojson'] - Specify the desired response format of results (geojson, default) or for backwards compatibility (v5).
Expand Down Expand Up @@ -219,7 +220,7 @@ GeocodingV6.reverseGeocode = function(config) {
limit: v.number,
language: v.string,
worldview: v.string,
permanent: v.boolean,
permanent: v.boolean
})(config);

var query = stringifyBooleans(
Expand Down
Loading