Skip to content

Commit 0e19cc9

Browse files
committed
docs, bump package version
1 parent ae00cc5 commit 0e19cc9

File tree

5 files changed

+13
-1
lines changed

5 files changed

+13
-1
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Changelog
22

3+
## 0.16.1
4+
5+
- **Add:** Add `session_token` as optional parameter in the geocoding services
6+
37
## 0.16.0
48

59
- **Add:** Add `depart_at` as optional parameter in the isochrone service

docs/services.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1687,6 +1687,7 @@ See the [public documentation][241].
16871687
* `config.routing` **[boolean][209]** Specify whether to request additional metadata about the recommended navigation destination. Only applicable for address features. (optional, default `false`)
16881688
* `config.fuzzyMatch` **[boolean][209]** Specify whether the Geocoding API should attempt approximate, as well as exact, matching. (optional, default `true`)
16891689
* `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"`)
1690+
* `config.session_token` **[String][208]?** A unique session identifier generated by the client.
16901691

16911692
#### Examples
16921693

@@ -1758,6 +1759,7 @@ See the [public documentation][245].
17581759
* `config.reverseMode` **(`"distance"` | `"score"`)** Set the factors that are used to sort nearby results. (optional, default `'distance'`)
17591760
* `config.routing` **[boolean][209]** Specify whether to request additional metadata about the recommended navigation destination. Only applicable for address features. (optional, default `false`)
17601761
* `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"`)
1762+
* `config.session_token` **[String][208]?** A unique session identifier generated by the client.
17611763

17621764
#### Examples
17631765

@@ -2380,6 +2382,7 @@ See the [public documentation][264].
23802382
* `config.autocomplete` **[boolean][209]** Return autocomplete results or not. (optional, default `true`)
23812383
* `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`)
23822384
* `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"`)
2385+
* `config.session_token` **[String][208]?** A unique session identifier generated by the client.
23832386

23842387
#### Examples
23852388

@@ -2463,6 +2466,7 @@ See the [public documentation][265].
24632466
[ISO 639-1 language code][244] and optionally one or more IETF subtags for country or script.
24642467
* `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`)
24652468
* `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"`)
2469+
* `config.session_token` **[String][208]?** A unique session identifier generated by the client.
24662470

24672471
#### Examples
24682472

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@mapbox/mapbox-sdk",
3-
"version": "0.16.0",
3+
"version": "0.16.1",
44
"description": "JS SDK for accessing Mapbox APIs",
55
"main": "index.js",
66
"files": [

services/geocoding-v6.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ var featureTypes = [
5858
* @param {boolean} [config.autocomplete=true] - Return autocomplete results or not.
5959
* @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.
6060
* @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.
61+
* @param {String} [config.session_token] - A unique session identifier generated by the client.
6162
* @return {MapiRequest}
6263
*
6364
* @example
@@ -200,6 +201,7 @@ GeocodingV6.forwardGeocode = function(config) {
200201
* [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.
201202
* @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.
202203
* @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.
204+
* @param {String} [config.session_token] - A unique session identifier generated by the client.
203205
* @return {MapiRequest}
204206
*
205207
* @example

services/geocoding.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ var featureTypes = [
4848
* @param {boolean} [config.routing=false] - Specify whether to request additional metadata about the recommended navigation destination. Only applicable for address features.
4949
* @param {boolean} [config.fuzzyMatch=true] - Specify whether the Geocoding API should attempt approximate, as well as exact, matching.
5050
* @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.
51+
* @param {String} [config.session_token] - A unique session identifier generated by the client.
5152
* @return {MapiRequest}
5253
*
5354
* @example
@@ -155,6 +156,7 @@ Geocoding.forwardGeocode = function(config) {
155156
* @param {'distance'|'score'} [config.reverseMode='distance'] - Set the factors that are used to sort nearby results.
156157
* @param {boolean} [config.routing=false] - Specify whether to request additional metadata about the recommended navigation destination. Only applicable for address features.
157158
* @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.
159+
* @param {String} [config.session_token] - A unique session identifier generated by the client.
158160
* @return {MapiRequest}
159161
*
160162
* @example

0 commit comments

Comments
 (0)