Skip to content

Commit

Permalink
docs, bump package version
Browse files Browse the repository at this point in the history
  • Loading branch information
mpothier committed Sep 13, 2024
1 parent ae00cc5 commit 0e19cc9
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 1 deletion.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## 0.16.1

- **Add:** Add `session_token` as optional parameter in the geocoding services

## 0.16.0

- **Add:** Add `depart_at` as optional parameter in the isochrone service
Expand Down
4 changes: 4 additions & 0 deletions docs/services.md
Original file line number Diff line number Diff line change
Expand Up @@ -1687,6 +1687,7 @@ See the [public documentation][241].
* `config.routing` **[boolean][209]** Specify whether to request additional metadata about the recommended navigation destination. Only applicable for address features. (optional, default `false`)
* `config.fuzzyMatch` **[boolean][209]** Specify whether the Geocoding API should attempt approximate, as well as exact, matching. (optional, default `true`)
* `config.worldview` **[String][208]** Filter results to geographic features whose characteristics are defined differently by audiences belonging to various regional, cultural, or political groups. (optional, default `"us"`)
* `config.session_token` **[String][208]?** A unique session identifier generated by the client.

#### Examples

Expand Down Expand Up @@ -1758,6 +1759,7 @@ See the [public documentation][245].
* `config.reverseMode` **(`"distance"` | `"score"`)** Set the factors that are used to sort nearby results. (optional, default `'distance'`)
* `config.routing` **[boolean][209]** Specify whether to request additional metadata about the recommended navigation destination. Only applicable for address features. (optional, default `false`)
* `config.worldview` **[String][208]** Filter results to geographic features whose characteristics are defined differently by audiences belonging to various regional, cultural, or political groups. (optional, default `"us"`)
* `config.session_token` **[String][208]?** A unique session identifier generated by the client.

#### Examples

Expand Down Expand Up @@ -2380,6 +2382,7 @@ See the [public documentation][264].
* `config.autocomplete` **[boolean][209]** Return autocomplete results or not. (optional, default `true`)
* `config.permanent` **[boolean][209]** Specify whether you intend to store the results of the query (true) or not (false, default). Temporary results are not allowed to be cached, while Permanent results are allowed to be cached and stored indefinitely. (optional, default `false`)
* `config.worldview` **[String][208]** Filter results to geographic features whose characteristics are defined differently by audiences belonging to various regional, cultural, or political groups. (optional, default `"us"`)
* `config.session_token` **[String][208]?** A unique session identifier generated by the client.

#### Examples

Expand Down Expand Up @@ -2463,6 +2466,7 @@ See the [public documentation][265].
[ISO 639-1 language code][244] and optionally one or more IETF subtags for country or script.
* `config.permanent` **[boolean][209]** Specify whether you intend to store the results of the query (true) or not (false, default). Temporary results are not allowed to be cached, while Permanent results are allowed to be cached and stored indefinitely. (optional, default `false`)
* `config.worldview` **[String][208]** Filter results to geographic features whose characteristics are defined differently by audiences belonging to various regional, cultural, or political groups. (optional, default `"us"`)
* `config.session_token` **[String][208]?** A unique session identifier generated by the client.

#### Examples

Expand Down
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.16.0",
"version": "0.16.1",
"description": "JS SDK for accessing Mapbox APIs",
"main": "index.js",
"files": [
Expand Down
2 changes: 2 additions & 0 deletions services/geocoding-v6.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ var featureTypes = [
* @param {boolean} [config.autocomplete=true] - Return autocomplete results or not.
* @param {boolean} [config.permanent=false] - Specify whether you intend to store the results of the query (true) or not (false, default). Temporary results are not allowed to be cached, while Permanent results are allowed to be cached and stored indefinitely.
* @param {String} [config.worldview="us"] - Filter results to geographic features whose characteristics are defined differently by audiences belonging to various regional, cultural, or political groups.
* @param {String} [config.session_token] - A unique session identifier generated by the client.
* @return {MapiRequest}
*
* @example
Expand Down Expand Up @@ -200,6 +201,7 @@ GeocodingV6.forwardGeocode = function(config) {
* [ISO 639-1 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) and optionally one or more IETF subtags for country or script.
* @param {boolean} [config.permanent=false] - Specify whether you intend to store the results of the query (true) or not (false, default). Temporary results are not allowed to be cached, while Permanent results are allowed to be cached and stored indefinitely.
* @param {String} [config.worldview="us"] - Filter results to geographic features whose characteristics are defined differently by audiences belonging to various regional, cultural, or political groups.
* @param {String} [config.session_token] - A unique session identifier generated by the client.
* @return {MapiRequest}
*
* @example
Expand Down
2 changes: 2 additions & 0 deletions services/geocoding.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ var featureTypes = [
* @param {boolean} [config.routing=false] - Specify whether to request additional metadata about the recommended navigation destination. Only applicable for address features.
* @param {boolean} [config.fuzzyMatch=true] - Specify whether the Geocoding API should attempt approximate, as well as exact, matching.
* @param {String} [config.worldview="us"] - Filter results to geographic features whose characteristics are defined differently by audiences belonging to various regional, cultural, or political groups.
* @param {String} [config.session_token] - A unique session identifier generated by the client.
* @return {MapiRequest}
*
* @example
Expand Down Expand Up @@ -155,6 +156,7 @@ Geocoding.forwardGeocode = function(config) {
* @param {'distance'|'score'} [config.reverseMode='distance'] - Set the factors that are used to sort nearby results.
* @param {boolean} [config.routing=false] - Specify whether to request additional metadata about the recommended navigation destination. Only applicable for address features.
* @param {String} [config.worldview="us"] - Filter results to geographic features whose characteristics are defined differently by audiences belonging to various regional, cultural, or political groups.
* @param {String} [config.session_token] - A unique session identifier generated by the client.
* @return {MapiRequest}
*
* @example
Expand Down

0 comments on commit 0e19cc9

Please sign in to comment.