@types/mapbox__mapbox-sdk 0.13.0 → 0.13.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- mapbox__mapbox-sdk/README.md +2 -2
- mapbox__mapbox-sdk/index.d.ts +162 -159
- mapbox__mapbox-sdk/package.json +3 -4
mapbox__mapbox-sdk/README.md
CHANGED
|
@@ -8,8 +8,8 @@ This package contains type definitions for @mapbox/mapbox-sdk (https://github.co
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mapbox__mapbox-sdk.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated: Thu,
|
|
12
|
-
* Dependencies: [@types/
|
|
11
|
+
* Last updated: Thu, 07 Apr 2022 05:31:19 GMT
|
|
12
|
+
* Dependencies: [@types/geojson](https://npmjs.com/package/@types/geojson), [@types/mapbox-gl](https://npmjs.com/package/@types/mapbox-gl), [@types/node](https://npmjs.com/package/@types/node)
|
|
13
13
|
* Global values: none
|
|
14
14
|
|
|
15
15
|
# Credits
|
mapbox__mapbox-sdk/index.d.ts
CHANGED
|
@@ -15,13 +15,13 @@ declare module '@mapbox/mapbox-sdk/lib/classes/mapi-client' {
|
|
|
15
15
|
export default class MapiClient {
|
|
16
16
|
constructor(config: SdkConfig);
|
|
17
17
|
accessToken: string;
|
|
18
|
-
origin?: string;
|
|
18
|
+
origin?: string | undefined;
|
|
19
19
|
createRequest(requestOptions: MapiRequestOptions): MapiRequest;
|
|
20
20
|
}
|
|
21
21
|
|
|
22
22
|
interface SdkConfig {
|
|
23
23
|
accessToken: string;
|
|
24
|
-
origin?: string;
|
|
24
|
+
origin?: string | undefined;
|
|
25
25
|
}
|
|
26
26
|
}
|
|
27
27
|
|
|
@@ -92,11 +92,11 @@ declare module '@mapbox/mapbox-sdk/lib/classes/mapi-request' {
|
|
|
92
92
|
/**
|
|
93
93
|
* If this request has been sent and received a response, the response is available on this property.
|
|
94
94
|
*/
|
|
95
|
-
response?: MapiResponse;
|
|
95
|
+
response?: MapiResponse | undefined;
|
|
96
96
|
/**
|
|
97
97
|
* If this request has been sent and received an error in response, the error is available on this property.
|
|
98
98
|
*/
|
|
99
|
-
error?: MapiError | Error;
|
|
99
|
+
error?: MapiError | Error | undefined;
|
|
100
100
|
/**
|
|
101
101
|
* If the request has been aborted (via abort), this property will be true.
|
|
102
102
|
*/
|
|
@@ -176,7 +176,7 @@ declare module '@mapbox/mapbox-sdk/lib/classes/mapi-error' {
|
|
|
176
176
|
/**
|
|
177
177
|
* The numeric status code of the HTTP response
|
|
178
178
|
*/
|
|
179
|
-
statusCode?: number;
|
|
179
|
+
statusCode?: number | undefined;
|
|
180
180
|
/**
|
|
181
181
|
* If the server sent a response body, this property exposes that response, parsed as JSON if possible.
|
|
182
182
|
*/
|
|
@@ -184,7 +184,7 @@ declare module '@mapbox/mapbox-sdk/lib/classes/mapi-error' {
|
|
|
184
184
|
/**
|
|
185
185
|
* Whatever message could be derived from the call site and HTTP response.
|
|
186
186
|
*/
|
|
187
|
-
message?: string;
|
|
187
|
+
message?: string | undefined;
|
|
188
188
|
}
|
|
189
189
|
}
|
|
190
190
|
|
|
@@ -201,12 +201,12 @@ declare module '@mapbox/mapbox-sdk/services/datasets' {
|
|
|
201
201
|
/**
|
|
202
202
|
* List datasets in your account.
|
|
203
203
|
*/
|
|
204
|
-
listDatasets(config?: { sortby?: 'created' | 'modified' }): MapiRequest;
|
|
204
|
+
listDatasets(config?: { sortby?: 'created' | 'modified' | undefined }): MapiRequest;
|
|
205
205
|
/**
|
|
206
206
|
* Create a new, empty dataset.
|
|
207
207
|
* @param config Object
|
|
208
208
|
*/
|
|
209
|
-
createDataset(config: { name?: string; description?: string }): MapiRequest;
|
|
209
|
+
createDataset(config: { name?: string | undefined; description?: string | undefined }): MapiRequest;
|
|
210
210
|
/**
|
|
211
211
|
* Get metadata about a dataset.
|
|
212
212
|
* @param config
|
|
@@ -216,7 +216,7 @@ declare module '@mapbox/mapbox-sdk/services/datasets' {
|
|
|
216
216
|
* Update user-defined properties of a dataset's metadata.
|
|
217
217
|
* @param config
|
|
218
218
|
*/
|
|
219
|
-
updateMetadata(config: { datasetId?: string; name?: string; description?: string }): MapiRequest;
|
|
219
|
+
updateMetadata(config: { datasetId?: string | undefined; name?: string | undefined; description?: string | undefined }): MapiRequest;
|
|
220
220
|
/**
|
|
221
221
|
* Delete a dataset, including all features it contains.
|
|
222
222
|
* @param config
|
|
@@ -227,7 +227,7 @@ declare module '@mapbox/mapbox-sdk/services/datasets' {
|
|
|
227
227
|
* This endpoint supports pagination. Use MapiRequest#eachPage or manually specify the limit and start options.
|
|
228
228
|
* @param config
|
|
229
229
|
*/
|
|
230
|
-
listFeatures(config: { datasetId: string; limit?: number; start?: string }): MapiRequest;
|
|
230
|
+
listFeatures(config: { datasetId: string; limit?: number | undefined; start?: string | undefined }): MapiRequest;
|
|
231
231
|
/**
|
|
232
232
|
* Add a feature to a dataset or update an existing one.
|
|
233
233
|
* @param config
|
|
@@ -358,72 +358,72 @@ declare module '@mapbox/mapbox-sdk/services/directions' {
|
|
|
358
358
|
* different than the fastest route, but also still reasonably fast. Such a route does not exist in all circumstances.
|
|
359
359
|
* Currently up to two alternatives can be returned. Can be true or false (default).
|
|
360
360
|
*/
|
|
361
|
-
alternatives?: boolean;
|
|
361
|
+
alternatives?: boolean | undefined;
|
|
362
362
|
/**
|
|
363
363
|
* Whether or not to return additional metadata along the route. Possible values are: duration , distance , speed , and congestion .
|
|
364
364
|
* Several annotations can be used by including them as a comma-separated list. See the RouteLeg object for more details on
|
|
365
365
|
* what is included with annotations.
|
|
366
366
|
*/
|
|
367
|
-
annotations?: DirectionsAnnotation[];
|
|
367
|
+
annotations?: DirectionsAnnotation[] | undefined;
|
|
368
368
|
|
|
369
369
|
/**
|
|
370
370
|
* Whether or not to return banner objects associated with the routeSteps .
|
|
371
371
|
* Should be used in conjunction with steps . Can be true or false . The default is false .
|
|
372
372
|
*/
|
|
373
|
-
bannerInstructions?: boolean;
|
|
373
|
+
bannerInstructions?: boolean | undefined;
|
|
374
374
|
|
|
375
375
|
/**
|
|
376
376
|
* Sets the allowed direction of travel when departing intermediate waypoints. If true , the route will continue in the same
|
|
377
377
|
* direction of travel. If false , the route may continue in the opposite direction of travel. Defaults to true for mapbox/driving and
|
|
378
378
|
* false for mapbox/walking and mapbox/cycling .
|
|
379
379
|
*/
|
|
380
|
-
continueStraight?: boolean;
|
|
380
|
+
continueStraight?: boolean | undefined;
|
|
381
381
|
/**
|
|
382
382
|
* Format of the returned geometry. Allowed values are: geojson (as LineString ),
|
|
383
383
|
* polyline with precision 5, polyline6 (a polyline with precision 6). The default value is polyline .
|
|
384
384
|
*/
|
|
385
|
-
geometries?: DirectionsGeometry;
|
|
385
|
+
geometries?: DirectionsGeometry | undefined;
|
|
386
386
|
/**
|
|
387
387
|
* Language of returned turn-by-turn text instructions. See supported languages . The default is en for English.
|
|
388
388
|
*/
|
|
389
|
-
language?: string;
|
|
389
|
+
language?: string | undefined;
|
|
390
390
|
/**
|
|
391
391
|
* Type of returned overview geometry. Can be full (the most detailed geometry available),
|
|
392
392
|
* simplified (a simplified version of the full geometry), or false (no overview geometry). The default is simplified .
|
|
393
393
|
*/
|
|
394
|
-
overview?: DirectionsOverview;
|
|
394
|
+
overview?: DirectionsOverview | undefined;
|
|
395
395
|
|
|
396
396
|
/**
|
|
397
397
|
* Emit instructions at roundabout exits. Can be true or false . The default is false .
|
|
398
398
|
*/
|
|
399
|
-
roundaboutExits?: boolean;
|
|
399
|
+
roundaboutExits?: boolean | undefined;
|
|
400
400
|
/**
|
|
401
401
|
* Whether to return steps and turn-by-turn instructions. Can be true or false . The default is false .
|
|
402
402
|
*/
|
|
403
|
-
steps?: boolean;
|
|
403
|
+
steps?: boolean | undefined;
|
|
404
404
|
/**
|
|
405
405
|
* Whether or not to return SSML marked-up text for voice guidance along the route. Should be used in conjunction with steps .
|
|
406
406
|
* Can be true or false . The default is false .
|
|
407
407
|
*/
|
|
408
|
-
voiceInstructions?: boolean;
|
|
408
|
+
voiceInstructions?: boolean | undefined;
|
|
409
409
|
/**
|
|
410
410
|
* Which type of units to return in the text for voice instructions. Can be imperial or metric . Default is imperial .
|
|
411
411
|
*/
|
|
412
|
-
voiceUnits?: DirectionsUnits;
|
|
412
|
+
voiceUnits?: DirectionsUnits | undefined;
|
|
413
413
|
}
|
|
414
414
|
|
|
415
415
|
type DirectionsProfileExclusion =
|
|
416
416
|
| {
|
|
417
417
|
profile: 'walking';
|
|
418
|
-
exclude?: [];
|
|
418
|
+
exclude?: [] | undefined;
|
|
419
419
|
}
|
|
420
420
|
| {
|
|
421
421
|
profile: 'cycling';
|
|
422
|
-
exclude?: Array<'ferry'
|
|
422
|
+
exclude?: Array<'ferry'> | undefined;
|
|
423
423
|
}
|
|
424
424
|
| {
|
|
425
425
|
profile: 'driving' | 'driving-traffic';
|
|
426
|
-
exclude?: Array<'ferry' | 'toll' | 'motorway'
|
|
426
|
+
exclude?: Array<'ferry' | 'toll' | 'motorway'> | undefined;
|
|
427
427
|
};
|
|
428
428
|
|
|
429
429
|
type DirectionsRequest = CommonDirectionsRequest & DirectionsProfileExclusion;
|
|
@@ -438,7 +438,7 @@ declare module '@mapbox/mapbox-sdk/services/directions' {
|
|
|
438
438
|
* This option should always be used in conjunction with a `radius`. The first values is angle clockwise from true
|
|
439
439
|
* north between 0 and 360, and the second is the range of degrees the angle can deviate by.
|
|
440
440
|
*/
|
|
441
|
-
bearing?: Coordinates;
|
|
441
|
+
bearing?: Coordinates | undefined;
|
|
442
442
|
/**
|
|
443
443
|
* Used to indicate how requested routes consider from which side of the road to approach a waypoint.
|
|
444
444
|
* Accepts unrestricted (default) or curb . If set to unrestricted , the routes can approach waypoints from either side of the road.
|
|
@@ -447,21 +447,21 @@ declare module '@mapbox/mapbox-sdk/services/directions' {
|
|
|
447
447
|
* while bearings influences how you start from a waypoint. If provided, the list of approaches must be the same length as the list of waypoints.
|
|
448
448
|
* However, you can skip a coordinate and show its position in the list with the ; separator.
|
|
449
449
|
*/
|
|
450
|
-
approach?: DirectionsApproach;
|
|
450
|
+
approach?: DirectionsApproach | undefined;
|
|
451
451
|
/**
|
|
452
452
|
* Maximum distance in meters that each coordinate is allowed to move when snapped to a nearby road segment.
|
|
453
453
|
* There must be as many radiuses as there are coordinates in the request, each separated by ';'.
|
|
454
454
|
* Values can be any number greater than 0 or the string 'unlimited'.
|
|
455
455
|
* A NoSegment error is returned if no routable road is found within the radius.
|
|
456
456
|
*/
|
|
457
|
-
radius?: number | 'unlimited';
|
|
457
|
+
radius?: number | 'unlimited' | undefined;
|
|
458
458
|
}
|
|
459
459
|
|
|
460
460
|
type DirectionsWaypoint = Waypoint & {
|
|
461
461
|
/**
|
|
462
462
|
* Custom name for the waypoint used for the arrival instruction in banners and voice instructions.
|
|
463
463
|
*/
|
|
464
|
-
waypointName?: string;
|
|
464
|
+
waypointName?: string | undefined;
|
|
465
465
|
};
|
|
466
466
|
|
|
467
467
|
interface DirectionsResponse {
|
|
@@ -513,7 +513,7 @@ declare module '@mapbox/mapbox-sdk/services/directions' {
|
|
|
513
513
|
/**
|
|
514
514
|
* String of the locale used for voice instructions. Defaults to en, and can be any accepted instruction language.
|
|
515
515
|
*/
|
|
516
|
-
voiceLocale?: string;
|
|
516
|
+
voiceLocale?: string | undefined;
|
|
517
517
|
}
|
|
518
518
|
|
|
519
519
|
interface Leg {
|
|
@@ -570,7 +570,7 @@ declare module '@mapbox/mapbox-sdk/services/directions' {
|
|
|
570
570
|
* and a route number. You should not assume that the network code is globally unique: for example, a network code of “NH” may appear on a
|
|
571
571
|
* “National Highway” or “New Hampshire”. Moreover, a route number may not even uniquely identify a road within a given network.
|
|
572
572
|
*/
|
|
573
|
-
ref?: string;
|
|
573
|
+
ref?: string | undefined;
|
|
574
574
|
weight: number;
|
|
575
575
|
/**
|
|
576
576
|
* Number indicating the estimated time traveled time in seconds from the maneuver to the next RouteStep.
|
|
@@ -589,16 +589,16 @@ declare module '@mapbox/mapbox-sdk/services/directions' {
|
|
|
589
589
|
/**
|
|
590
590
|
* String with the destinations of the way along which the travel proceeds. Optionally included, if data is available.
|
|
591
591
|
*/
|
|
592
|
-
destinations?: string;
|
|
592
|
+
destinations?: string | undefined;
|
|
593
593
|
/**
|
|
594
594
|
* String with the exit numbers or names of the way. Optionally included, if data is available.
|
|
595
595
|
*/
|
|
596
|
-
exits?: string;
|
|
596
|
+
exits?: string | undefined;
|
|
597
597
|
/**
|
|
598
598
|
* A string containing an IPA phonetic transcription indicating how to pronounce the name in the name property.
|
|
599
599
|
* This property is omitted if pronunciation data is unavailable for the step.
|
|
600
600
|
*/
|
|
601
|
-
pronunciation?: string;
|
|
601
|
+
pronunciation?: string | undefined;
|
|
602
602
|
}
|
|
603
603
|
|
|
604
604
|
interface Instruction {
|
|
@@ -615,16 +615,16 @@ declare module '@mapbox/mapbox-sdk/services/directions' {
|
|
|
615
615
|
* The type of maneuver. May be used in combination with the modifier (and, if it is a roundabout, the degrees) to for an icon to
|
|
616
616
|
* display. Possible values: 'turn', 'merge', 'depart', 'arrive', 'fork', 'off ramp', 'roundabout'
|
|
617
617
|
*/
|
|
618
|
-
type?: string;
|
|
618
|
+
type?: string | undefined;
|
|
619
619
|
/**
|
|
620
620
|
* The modifier for the maneuver. Can be used in combination with the type (and, if it is a roundabout, the degrees)
|
|
621
621
|
* to for an icon to display. Possible values: 'left', 'right', 'slight left', 'slight right', 'sharp left', 'sharp right', 'straight', 'uturn'
|
|
622
622
|
*/
|
|
623
|
-
modifier?: ManeuverModifier;
|
|
623
|
+
modifier?: ManeuverModifier | undefined;
|
|
624
624
|
/**
|
|
625
625
|
* The degrees at which you will be exiting a roundabout, assuming 180 indicates going straight through the roundabout.
|
|
626
626
|
*/
|
|
627
|
-
degrees?: number;
|
|
627
|
+
degrees?: number | undefined;
|
|
628
628
|
/**
|
|
629
629
|
* A string representing which side the of the street people drive on in that location. Can be 'left' or 'right'.
|
|
630
630
|
*/
|
|
@@ -644,14 +644,14 @@ declare module '@mapbox/mapbox-sdk/services/directions' {
|
|
|
644
644
|
/**
|
|
645
645
|
* Additional content useful for visual guidance. Our SDK displays this text slightly smaller and below the primary. Can be null.
|
|
646
646
|
*/
|
|
647
|
-
secondary?: Instruction[];
|
|
647
|
+
secondary?: Instruction[] | undefined;
|
|
648
648
|
then?: any;
|
|
649
649
|
/**
|
|
650
650
|
* Additional information that is included if we feel the driver needs a heads up about something.
|
|
651
651
|
* Can include information about the next maneuver (the one after the upcoming one) if the step is short -
|
|
652
652
|
* can be null, or can be lane information. If we have lane information, that trumps information about the next maneuver.
|
|
653
653
|
*/
|
|
654
|
-
sub?: Sub;
|
|
654
|
+
sub?: Sub | undefined;
|
|
655
655
|
}
|
|
656
656
|
|
|
657
657
|
interface Sub {
|
|
@@ -681,7 +681,7 @@ declare module '@mapbox/mapbox-sdk/services/directions' {
|
|
|
681
681
|
* The abbreviated form of text. If this is present, there will also be an abbr_priority value.
|
|
682
682
|
* See the Examples of Abbreviations table below for an example of using abbr and abbr_priority.
|
|
683
683
|
*/
|
|
684
|
-
abbr?: string;
|
|
684
|
+
abbr?: string | undefined;
|
|
685
685
|
/**
|
|
686
686
|
* An integer indicating the order in which the abbreviation abbr should be used in place of text.
|
|
687
687
|
* The highest priority is 0 and a higher integer value means it should have a lower priority. There are no gaps in
|
|
@@ -689,16 +689,16 @@ declare module '@mapbox/mapbox-sdk/services/directions' {
|
|
|
689
689
|
* same abbr_priority should be abbreviated at the same time. Finding no larger values of abbr_priority means that the
|
|
690
690
|
* string is fully abbreviated.
|
|
691
691
|
*/
|
|
692
|
-
abbr_priority?: number;
|
|
692
|
+
abbr_priority?: number | undefined;
|
|
693
693
|
/**
|
|
694
694
|
* String pointing to a shield image to use instead of the text.
|
|
695
695
|
*/
|
|
696
|
-
imageBaseURL?: string;
|
|
696
|
+
imageBaseURL?: string | undefined;
|
|
697
697
|
/**
|
|
698
698
|
* (present if component is lane): An array indicating which directions you can go from a lane (left, right, or straight).
|
|
699
699
|
* If the value is ['left', 'straight'], the driver can go straight or left from that lane
|
|
700
700
|
*/
|
|
701
|
-
directions?: string[];
|
|
701
|
+
directions?: string[] | undefined;
|
|
702
702
|
/**
|
|
703
703
|
* (present if component is lane): A boolean telling you if that lane can be used to complete the upcoming maneuver.
|
|
704
704
|
* If multiple lanes are active, then they can all be used to complete the upcoming maneuver.
|
|
@@ -738,7 +738,7 @@ declare module '@mapbox/mapbox-sdk/services/directions' {
|
|
|
738
738
|
/**
|
|
739
739
|
* Optional String indicating the direction change of the maneuver
|
|
740
740
|
*/
|
|
741
|
-
modifier?: ManeuverModifier;
|
|
741
|
+
modifier?: ManeuverModifier | undefined;
|
|
742
742
|
/**
|
|
743
743
|
* String indicating the type of maneuver
|
|
744
744
|
*/
|
|
@@ -755,7 +755,7 @@ declare module '@mapbox/mapbox-sdk/services/directions' {
|
|
|
755
755
|
* the direction of travel after the maneuver/passing the intersection.
|
|
756
756
|
* The value is not supplied for arrive maneuvers.
|
|
757
757
|
*/
|
|
758
|
-
out?: number;
|
|
758
|
+
out?: number | undefined;
|
|
759
759
|
/**
|
|
760
760
|
* A list of entry flags, corresponding in a 1:1 relationship to the bearings.
|
|
761
761
|
* A value of true indicates that the respective road could be entered on a valid route.
|
|
@@ -776,11 +776,11 @@ declare module '@mapbox/mapbox-sdk/services/directions' {
|
|
|
776
776
|
* north to the direction of travel before the maneuver/passing the intersection. To get the bearing in the direction of driving,
|
|
777
777
|
* the bearing has to be rotated by a value of 180. The value is not supplied for departure maneuvers.
|
|
778
778
|
*/
|
|
779
|
-
in?: number;
|
|
779
|
+
in?: number | undefined;
|
|
780
780
|
/**
|
|
781
781
|
* An array of strings signifying the classes of the road exiting the intersection.
|
|
782
782
|
*/
|
|
783
|
-
classes?: DirectionsClass[];
|
|
783
|
+
classes?: DirectionsClass[] | undefined;
|
|
784
784
|
/**
|
|
785
785
|
* Array of Lane objects that represent the available turn lanes at the intersection.
|
|
786
786
|
* If no lane information is available for an intersection, the lanes property will not be present.
|
|
@@ -842,41 +842,41 @@ declare module '@mapbox/mapbox-sdk/services/geocoding' {
|
|
|
842
842
|
/**
|
|
843
843
|
* Either mapbox.places for ephemeral geocoding, or mapbox.places-permanent for storing results and batch geocoding.
|
|
844
844
|
*/
|
|
845
|
-
mode
|
|
845
|
+
mode?: GeocodeMode;
|
|
846
846
|
/**
|
|
847
847
|
* Limit results to one or more countries. Options are ISO 3166 alpha 2 country codes
|
|
848
848
|
*/
|
|
849
|
-
countries?: string[];
|
|
849
|
+
countries?: string[] | undefined;
|
|
850
850
|
/**
|
|
851
851
|
* Bias local results based on a provided location. Options are longitude,latitude coordinates.
|
|
852
852
|
*/
|
|
853
|
-
proximity?: Coordinates;
|
|
853
|
+
proximity?: Coordinates | undefined;
|
|
854
854
|
/**
|
|
855
855
|
* Filter results by one or more feature types
|
|
856
856
|
*/
|
|
857
|
-
types?: GeocodeQueryType[];
|
|
857
|
+
types?: GeocodeQueryType[] | undefined;
|
|
858
858
|
/**
|
|
859
859
|
* Forward geocoding only. Return autocomplete results or not. Options are true or false and the default is true .
|
|
860
860
|
*/
|
|
861
|
-
autocomplete?: boolean;
|
|
861
|
+
autocomplete?: boolean | undefined;
|
|
862
862
|
/**
|
|
863
863
|
* Forward geocoding only. Limit results to a bounding box. Options are in the format minLongitude,minLatitude,maxLongitude,maxLatitude.
|
|
864
864
|
*/
|
|
865
|
-
bbox?: BoundingBox;
|
|
865
|
+
bbox?: BoundingBox | undefined;
|
|
866
866
|
/**
|
|
867
867
|
* Limit the number of results returned. The default is 5 for forward geocoding and 1 for reverse geocoding.
|
|
868
868
|
*/
|
|
869
|
-
limit?: number;
|
|
869
|
+
limit?: number | undefined;
|
|
870
870
|
/**
|
|
871
871
|
* Specify the language to use for response text and, for forward geocoding, query result weighting.
|
|
872
872
|
* Options are IETF language tags comprised of a mandatory ISO 639-1 language code and optionally one or more
|
|
873
873
|
* IETF subtags for country or script.
|
|
874
874
|
*/
|
|
875
|
-
language?: string[];
|
|
875
|
+
language?: string[] | undefined;
|
|
876
876
|
/**
|
|
877
877
|
* Specify whether to request additional etadat about the recommended navigation destination. Only applicable for address features.
|
|
878
878
|
*/
|
|
879
|
-
routing?: boolean;
|
|
879
|
+
routing?: boolean | undefined;
|
|
880
880
|
}
|
|
881
881
|
|
|
882
882
|
interface GeocodeResponse {
|
|
@@ -923,7 +923,7 @@ declare module '@mapbox/mapbox-sdk/services/geocoding' {
|
|
|
923
923
|
* A string of the house number for the returned address feature. Note that unlike the
|
|
924
924
|
* address property for poi features, this property is outside the properties object.
|
|
925
925
|
*/
|
|
926
|
-
address?: string;
|
|
926
|
+
address?: string | undefined;
|
|
927
927
|
/**
|
|
928
928
|
* An object describing the feature. The property object is unstable and only Carmen GeoJSON properties are guaranteed.
|
|
929
929
|
* Your implementation should check for the presence of these values in a response before it attempts to use them.
|
|
@@ -958,7 +958,7 @@ declare module '@mapbox/mapbox-sdk/services/geocoding' {
|
|
|
958
958
|
/**
|
|
959
959
|
* An array bounding box in the form [ minX,minY,maxX,maxY ] .
|
|
960
960
|
*/
|
|
961
|
-
bbox?: number[];
|
|
961
|
+
bbox?: number[] | undefined;
|
|
962
962
|
/**
|
|
963
963
|
* An array in the form [ longitude,latitude ] at the center of the specified bbox .
|
|
964
964
|
*/
|
|
@@ -992,24 +992,24 @@ declare module '@mapbox/mapbox-sdk/services/geocoding' {
|
|
|
992
992
|
/**
|
|
993
993
|
* The Wikidata identifier for the returned feature.
|
|
994
994
|
*/
|
|
995
|
-
wikidata?: string;
|
|
995
|
+
wikidata?: string | undefined;
|
|
996
996
|
/**
|
|
997
997
|
* A string of comma-separated categories for the returned poi feature.
|
|
998
998
|
*/
|
|
999
|
-
category?: string;
|
|
999
|
+
category?: string | undefined;
|
|
1000
1000
|
/**
|
|
1001
1001
|
* A formatted string of the telephone number for the returned poi feature.
|
|
1002
1002
|
*/
|
|
1003
|
-
tel?: string;
|
|
1003
|
+
tel?: string | undefined;
|
|
1004
1004
|
/**
|
|
1005
1005
|
* The name of a suggested Maki icon to visualize a poi feature based on its category .
|
|
1006
1006
|
*/
|
|
1007
|
-
maki?: string;
|
|
1007
|
+
maki?: string | undefined;
|
|
1008
1008
|
/**
|
|
1009
1009
|
* A boolean value indicating whether a poi feature is a landmark. Landmarks are
|
|
1010
1010
|
* particularly notable or long-lived features like schools, parks, museums and places of worship.
|
|
1011
1011
|
*/
|
|
1012
|
-
landmark?: boolean;
|
|
1012
|
+
landmark?: boolean | undefined;
|
|
1013
1013
|
/**
|
|
1014
1014
|
* The ISO 3166-1 country and ISO 3166-2 region code for the returned feature.
|
|
1015
1015
|
*/
|
|
@@ -1050,31 +1050,31 @@ declare module '@mapbox/mapbox-sdk/services/map-matching' {
|
|
|
1050
1050
|
/**
|
|
1051
1051
|
* A directions profile ID. (optional, default driving)
|
|
1052
1052
|
*/
|
|
1053
|
-
profile?: MapboxProfile;
|
|
1053
|
+
profile?: MapboxProfile | undefined;
|
|
1054
1054
|
/**
|
|
1055
1055
|
* Specify additional metadata that should be returned.
|
|
1056
1056
|
*/
|
|
1057
|
-
annotations?: DirectionsAnnotation;
|
|
1057
|
+
annotations?: DirectionsAnnotation | undefined;
|
|
1058
1058
|
/**
|
|
1059
1059
|
* Format of the returned geometry. (optional, default "polyline")
|
|
1060
1060
|
*/
|
|
1061
|
-
geometries?: DirectionsGeometry;
|
|
1061
|
+
geometries?: DirectionsGeometry | undefined;
|
|
1062
1062
|
/**
|
|
1063
1063
|
* Language of returned turn-by-turn text instructions. See supported languages. (optional, default "en")
|
|
1064
1064
|
*/
|
|
1065
|
-
language?: string;
|
|
1065
|
+
language?: string | undefined;
|
|
1066
1066
|
/**
|
|
1067
1067
|
* Type of returned overview geometry. (optional, default "simplified"
|
|
1068
1068
|
*/
|
|
1069
|
-
overview?: DirectionsOverview;
|
|
1069
|
+
overview?: DirectionsOverview | undefined;
|
|
1070
1070
|
/**
|
|
1071
1071
|
* Whether to return steps and turn-by-turn instructions. (optional, default false)
|
|
1072
1072
|
*/
|
|
1073
|
-
steps?: boolean;
|
|
1073
|
+
steps?: boolean | undefined;
|
|
1074
1074
|
/**
|
|
1075
1075
|
* Whether or not to transparently remove clusters and re-sample traces for improved map matching results. (optional, default false)
|
|
1076
1076
|
*/
|
|
1077
|
-
tidy?: boolean;
|
|
1077
|
+
tidy?: boolean | undefined;
|
|
1078
1078
|
}
|
|
1079
1079
|
|
|
1080
1080
|
interface Point {
|
|
@@ -1082,27 +1082,27 @@ declare module '@mapbox/mapbox-sdk/services/map-matching' {
|
|
|
1082
1082
|
/**
|
|
1083
1083
|
* Used to indicate how requested routes consider from which side of the road to approach a waypoint.
|
|
1084
1084
|
*/
|
|
1085
|
-
approach?: DirectionsApproach;
|
|
1085
|
+
approach?: DirectionsApproach | undefined;
|
|
1086
1086
|
}
|
|
1087
1087
|
|
|
1088
1088
|
interface MapMatchingPoint extends Point {
|
|
1089
1089
|
/**
|
|
1090
1090
|
* A number in meters indicating the assumed precision of the used tracking device.
|
|
1091
1091
|
*/
|
|
1092
|
-
radius?: number;
|
|
1092
|
+
radius?: number | undefined;
|
|
1093
1093
|
/**
|
|
1094
1094
|
* Whether this coordinate is waypoint or not. The first and last coordinates will always be waypoints.
|
|
1095
1095
|
*/
|
|
1096
|
-
isWaypoint?: boolean;
|
|
1096
|
+
isWaypoint?: boolean | undefined;
|
|
1097
1097
|
/**
|
|
1098
1098
|
* Custom name for the waypoint used for the arrival instruction in banners and voice instructions.
|
|
1099
1099
|
* Will be ignored unless isWaypoint is true.
|
|
1100
1100
|
*/
|
|
1101
|
-
waypointName?: boolean;
|
|
1101
|
+
waypointName?: boolean | undefined;
|
|
1102
1102
|
/**
|
|
1103
1103
|
* Datetime corresponding to the coordinate.
|
|
1104
1104
|
*/
|
|
1105
|
-
timestamp?: string | number | Date;
|
|
1105
|
+
timestamp?: string | number | Date | undefined;
|
|
1106
1106
|
}
|
|
1107
1107
|
|
|
1108
1108
|
interface MapMatchingResponse {
|
|
@@ -1175,16 +1175,16 @@ declare module '@mapbox/mapbox-sdk/services/matrix' {
|
|
|
1175
1175
|
|
|
1176
1176
|
interface MatrixRequest {
|
|
1177
1177
|
points: Point[];
|
|
1178
|
-
profile?: MapboxProfile;
|
|
1179
|
-
sources?: number[] | 'all';
|
|
1180
|
-
destinations?: number[] | 'all';
|
|
1181
|
-
annotations?: DirectionsAnnotation[];
|
|
1178
|
+
profile?: MapboxProfile | undefined;
|
|
1179
|
+
sources?: number[] | 'all' | undefined;
|
|
1180
|
+
destinations?: number[] | 'all' | undefined;
|
|
1181
|
+
annotations?: DirectionsAnnotation[] | undefined;
|
|
1182
1182
|
}
|
|
1183
1183
|
|
|
1184
1184
|
interface MatrixResponse {
|
|
1185
1185
|
code: string;
|
|
1186
|
-
durations?: number[][];
|
|
1187
|
-
distances?: number[][];
|
|
1186
|
+
durations?: number[][] | undefined;
|
|
1187
|
+
distances?: number[][] | undefined;
|
|
1188
1188
|
destinations: Destination[];
|
|
1189
1189
|
sources: Destination[];
|
|
1190
1190
|
}
|
|
@@ -1222,11 +1222,11 @@ declare module '@mapbox/mapbox-sdk/services/optimization' {
|
|
|
1222
1222
|
/**
|
|
1223
1223
|
* Return additional metadata along the route. You can include several annotations as a comma-separated list. Possible values are:
|
|
1224
1224
|
*/
|
|
1225
|
-
annotations?: OptimizationAnnotation[];
|
|
1225
|
+
annotations?: OptimizationAnnotation[] | undefined;
|
|
1226
1226
|
/**
|
|
1227
1227
|
* Specify the destination coordinate of the returned route. Accepts any (default) or last .
|
|
1228
1228
|
*/
|
|
1229
|
-
destination?: 'any' | 'last';
|
|
1229
|
+
destination?: 'any' | 'last' | undefined;
|
|
1230
1230
|
/**
|
|
1231
1231
|
* Specify pick-up and drop-off locations for a trip by providing a ; delimited list of number pairs that correspond with the coordinates list.
|
|
1232
1232
|
* The first number of a pair indicates the index to the coordinate of the pick-up location in the coordinates list,
|
|
@@ -1234,34 +1234,34 @@ declare module '@mapbox/mapbox-sdk/services/optimization' {
|
|
|
1234
1234
|
* Each pair must contain exactly 2 numbers, which cannot be the same.
|
|
1235
1235
|
* The returned solution will visit pick-up locations before visiting drop-off locations. The first location can only be a pick-up location, not a drop-off location.
|
|
1236
1236
|
*/
|
|
1237
|
-
distributions?: Distribution[];
|
|
1237
|
+
distributions?: Distribution[] | undefined;
|
|
1238
1238
|
/**
|
|
1239
1239
|
* The format of the returned geometry. Allowed values are: geojson (as LineString ), polyline (default, a polyline with precision 5), polyline6 (a polyline with precision 6).
|
|
1240
1240
|
*/
|
|
1241
|
-
geometries?: 'geojson' | 'polyline' | 'polyline6';
|
|
1241
|
+
geometries?: 'geojson' | 'polyline' | 'polyline6' | undefined;
|
|
1242
1242
|
/**
|
|
1243
1243
|
* The language of returned turn-by-turn text instructions. See supported languages . The default is en (English).
|
|
1244
1244
|
*/
|
|
1245
|
-
language?: string;
|
|
1245
|
+
language?: string | undefined;
|
|
1246
1246
|
/**
|
|
1247
1247
|
* The type of the returned overview geometry.
|
|
1248
1248
|
* Can be 'full' (the most detailed geometry available), 'simplified' (default, a simplified version of the full geometry), or 'false' (no overview geometry).
|
|
1249
1249
|
*/
|
|
1250
|
-
overview?: 'full' | 'simplified' | 'false';
|
|
1250
|
+
overview?: 'full' | 'simplified' | 'false' | undefined;
|
|
1251
1251
|
/**
|
|
1252
1252
|
* The coordinate at which to start the returned route. Accepts any (default) or first .
|
|
1253
1253
|
*/
|
|
1254
|
-
source?: 'any' | 'first';
|
|
1254
|
+
source?: 'any' | 'first' | undefined;
|
|
1255
1255
|
/**
|
|
1256
1256
|
* Whether to return steps and turn-by-turn instructions ( true ) or not ( false , default).
|
|
1257
1257
|
*/
|
|
1258
|
-
steps?: boolean;
|
|
1258
|
+
steps?: boolean | undefined;
|
|
1259
1259
|
/**
|
|
1260
1260
|
* Indicates whether the returned route is roundtrip, meaning the route returns to the first location ( true , default) or not ( false ).
|
|
1261
1261
|
* If roundtrip=false , the source and destination parameters are required but not all combinations will be possible.
|
|
1262
1262
|
* See the Fixing Start and End Points section below for additional notes.
|
|
1263
1263
|
*/
|
|
1264
|
-
roundtrip?: boolean;
|
|
1264
|
+
roundtrip?: boolean | undefined;
|
|
1265
1265
|
}
|
|
1266
1266
|
|
|
1267
1267
|
interface Distribution {
|
|
@@ -1279,7 +1279,7 @@ declare module '@mapbox/mapbox-sdk/services/optimization' {
|
|
|
1279
1279
|
}
|
|
1280
1280
|
|
|
1281
1281
|
declare module '@mapbox/mapbox-sdk/services/static' {
|
|
1282
|
-
import { LngLatLike, LngLatBoundsLike } from 'mapbox-gl';
|
|
1282
|
+
import { LngLatLike, LngLatBoundsLike, AnyLayer } from 'mapbox-gl';
|
|
1283
1283
|
import { MapiRequest } from '@mapbox/mapbox-sdk/lib/classes/mapi-request';
|
|
1284
1284
|
import MapiClient, { SdkConfig } from '@mapbox/mapbox-sdk/lib/classes/mapi-client';
|
|
1285
1285
|
|
|
@@ -1305,16 +1305,19 @@ declare module '@mapbox/mapbox-sdk/services/static' {
|
|
|
1305
1305
|
| {
|
|
1306
1306
|
coordinates: LngLatLike | 'auto';
|
|
1307
1307
|
zoom: number;
|
|
1308
|
-
bearing?: number;
|
|
1309
|
-
pitch?: number;
|
|
1308
|
+
bearing?: number | undefined;
|
|
1309
|
+
pitch?: number | undefined;
|
|
1310
1310
|
}
|
|
1311
1311
|
| 'auto';
|
|
1312
|
-
padding?: string;
|
|
1313
|
-
overlays?: Array<CustomMarkerOverlay | SimpleMarkerOverlay | PathOverlay | GeoJsonOverlay
|
|
1314
|
-
highRes?: boolean;
|
|
1315
|
-
|
|
1316
|
-
|
|
1317
|
-
|
|
1312
|
+
padding?: string | undefined;
|
|
1313
|
+
overlays?: Array<CustomMarkerOverlay | SimpleMarkerOverlay | PathOverlay | GeoJsonOverlay> | undefined;
|
|
1314
|
+
highRes?: boolean | undefined;
|
|
1315
|
+
before_layer?: string | undefined;
|
|
1316
|
+
addlayer?: AnyLayer | undefined;
|
|
1317
|
+
setfilter?: any[] | undefined;
|
|
1318
|
+
layer_id?: string | undefined;
|
|
1319
|
+
attribution?: boolean | undefined;
|
|
1320
|
+
logo?: boolean | undefined;
|
|
1318
1321
|
}
|
|
1319
1322
|
|
|
1320
1323
|
interface CustomMarkerOverlay {
|
|
@@ -1332,9 +1335,9 @@ declare module '@mapbox/mapbox-sdk/services/static' {
|
|
|
1332
1335
|
|
|
1333
1336
|
interface SimpleMarker {
|
|
1334
1337
|
coordinates: LngLatLike;
|
|
1335
|
-
label?: string;
|
|
1336
|
-
color?: string;
|
|
1337
|
-
size?: 'large' | 'small';
|
|
1338
|
+
label?: string | undefined;
|
|
1339
|
+
color?: string | undefined;
|
|
1340
|
+
size?: 'large' | 'small' | undefined;
|
|
1338
1341
|
}
|
|
1339
1342
|
|
|
1340
1343
|
interface PathOverlay {
|
|
@@ -1346,20 +1349,20 @@ declare module '@mapbox/mapbox-sdk/services/static' {
|
|
|
1346
1349
|
* An array of coordinates describing the path.
|
|
1347
1350
|
*/
|
|
1348
1351
|
coordinates: LngLatBoundsLike[];
|
|
1349
|
-
strokeWidth?: number;
|
|
1350
|
-
strokeColor?: string;
|
|
1352
|
+
strokeWidth?: number | undefined;
|
|
1353
|
+
strokeColor?: string | undefined;
|
|
1351
1354
|
/**
|
|
1352
1355
|
* Must be paired with strokeColor.
|
|
1353
1356
|
*/
|
|
1354
|
-
strokeOpacity?: number;
|
|
1357
|
+
strokeOpacity?: number | undefined;
|
|
1355
1358
|
/**
|
|
1356
1359
|
* Must be paired with strokeColor.
|
|
1357
1360
|
*/
|
|
1358
|
-
fillColor?: string;
|
|
1361
|
+
fillColor?: string | undefined;
|
|
1359
1362
|
/**
|
|
1360
1363
|
* Must be paired with strokeColor.
|
|
1361
1364
|
*/
|
|
1362
|
-
fillOpacity?: number;
|
|
1365
|
+
fillOpacity?: number | undefined;
|
|
1363
1366
|
}
|
|
1364
1367
|
|
|
1365
1368
|
interface GeoJsonOverlay {
|
|
@@ -1384,17 +1387,17 @@ declare module '@mapbox/mapbox-sdk/services/styles' {
|
|
|
1384
1387
|
*/
|
|
1385
1388
|
getStyle(config: {
|
|
1386
1389
|
styleId: string;
|
|
1387
|
-
ownerId?: string;
|
|
1388
|
-
metadata?: boolean;
|
|
1389
|
-
draft?: boolean;
|
|
1390
|
-
fresh?: boolean;
|
|
1390
|
+
ownerId?: string | undefined;
|
|
1391
|
+
metadata?: boolean | undefined;
|
|
1392
|
+
draft?: boolean | undefined;
|
|
1393
|
+
fresh?: boolean | undefined;
|
|
1391
1394
|
}): MapiRequest;
|
|
1392
1395
|
/**
|
|
1393
1396
|
* Create a style.
|
|
1394
1397
|
* @param style
|
|
1395
1398
|
* @param ownerId
|
|
1396
1399
|
*/
|
|
1397
|
-
createStyle(config: { style: Style; ownerId?: string }): MapiRequest;
|
|
1400
|
+
createStyle(config: { style: Style; ownerId?: string | undefined }): MapiRequest;
|
|
1398
1401
|
/**
|
|
1399
1402
|
* Update a style.
|
|
1400
1403
|
* @param styleId
|
|
@@ -1406,21 +1409,21 @@ declare module '@mapbox/mapbox-sdk/services/styles' {
|
|
|
1406
1409
|
updateStyle(config: {
|
|
1407
1410
|
styleId: string;
|
|
1408
1411
|
style: Style;
|
|
1409
|
-
lastKnownModification?: string | number | Date;
|
|
1410
|
-
ownerId?: string;
|
|
1412
|
+
lastKnownModification?: string | number | Date | undefined;
|
|
1413
|
+
ownerId?: string | undefined;
|
|
1411
1414
|
}): void;
|
|
1412
1415
|
/**
|
|
1413
1416
|
* Delete a style.
|
|
1414
1417
|
* @param style
|
|
1415
1418
|
* @param ownerId
|
|
1416
1419
|
*/
|
|
1417
|
-
deleteStyle(config: { style: Style; ownerId?: string }): MapiRequest;
|
|
1420
|
+
deleteStyle(config: { style: Style; ownerId?: string | undefined }): MapiRequest;
|
|
1418
1421
|
/**
|
|
1419
1422
|
* List styles in your account.
|
|
1420
1423
|
* @param start
|
|
1421
1424
|
* @param ownerId
|
|
1422
1425
|
*/
|
|
1423
|
-
listStyles(config: { start?: string; ownerId?: string; fresh?: boolean }): MapiRequest;
|
|
1426
|
+
listStyles(config: { start?: string | undefined; ownerId?: string | undefined; fresh?: boolean | undefined }): MapiRequest;
|
|
1424
1427
|
/**
|
|
1425
1428
|
* Add an icon to a style, or update an existing one.
|
|
1426
1429
|
* @param styleId
|
|
@@ -1432,7 +1435,7 @@ declare module '@mapbox/mapbox-sdk/services/styles' {
|
|
|
1432
1435
|
styleId: string;
|
|
1433
1436
|
iconId: string;
|
|
1434
1437
|
file: Blob | ArrayBuffer | string;
|
|
1435
|
-
ownerId?: string;
|
|
1438
|
+
ownerId?: string | undefined;
|
|
1436
1439
|
}): MapiRequest;
|
|
1437
1440
|
/**
|
|
1438
1441
|
* Remove an icon from a style.
|
|
@@ -1441,7 +1444,7 @@ declare module '@mapbox/mapbox-sdk/services/styles' {
|
|
|
1441
1444
|
* @param ownerId
|
|
1442
1445
|
*/
|
|
1443
1446
|
// implicit any
|
|
1444
|
-
deleteStyleIcon(config: { styleId: string; iconId: string; ownerId?: string; draft?: boolean }): void;
|
|
1447
|
+
deleteStyleIcon(config: { styleId: string; iconId: string; ownerId?: string | undefined; draft?: boolean | undefined }): void;
|
|
1445
1448
|
/**
|
|
1446
1449
|
* Get a style sprite's image or JSON document.
|
|
1447
1450
|
* @param styleId
|
|
@@ -1451,11 +1454,11 @@ declare module '@mapbox/mapbox-sdk/services/styles' {
|
|
|
1451
1454
|
*/
|
|
1452
1455
|
getStyleSprite(config: {
|
|
1453
1456
|
styleId: string;
|
|
1454
|
-
format?: 'json' | 'png';
|
|
1455
|
-
highRes?: boolean;
|
|
1456
|
-
ownerId?: string;
|
|
1457
|
-
draft?: boolean;
|
|
1458
|
-
fresh?: boolean;
|
|
1457
|
+
format?: 'json' | 'png' | undefined;
|
|
1458
|
+
highRes?: boolean | undefined;
|
|
1459
|
+
ownerId?: string | undefined;
|
|
1460
|
+
draft?: boolean | undefined;
|
|
1461
|
+
fresh?: boolean | undefined;
|
|
1459
1462
|
}): MapiRequest;
|
|
1460
1463
|
/**
|
|
1461
1464
|
* Get a font glyph range.
|
|
@@ -1464,7 +1467,7 @@ declare module '@mapbox/mapbox-sdk/services/styles' {
|
|
|
1464
1467
|
* @param end
|
|
1465
1468
|
* @param ownerId
|
|
1466
1469
|
*/
|
|
1467
|
-
getFontGlyphRange(config: { fonts: string[]; start: number; end: number; ownerId?: string }): MapiRequest;
|
|
1470
|
+
getFontGlyphRange(config: { fonts: string[]; start: number; end: number; ownerId?: string | undefined }): MapiRequest;
|
|
1468
1471
|
/**
|
|
1469
1472
|
* Get embeddable HTML displaying a map.
|
|
1470
1473
|
* @param config
|
|
@@ -1476,13 +1479,13 @@ declare module '@mapbox/mapbox-sdk/services/styles' {
|
|
|
1476
1479
|
getEmbeddableHtml(config: {
|
|
1477
1480
|
config: any;
|
|
1478
1481
|
styleId: string;
|
|
1479
|
-
scrollZoom?: boolean;
|
|
1480
|
-
title?: boolean;
|
|
1481
|
-
fallback?: boolean;
|
|
1482
|
-
mapboxGLVersion?: string;
|
|
1483
|
-
mapboxGLGeocoderVersion?: string;
|
|
1484
|
-
ownerId?: string;
|
|
1485
|
-
draft?: string;
|
|
1482
|
+
scrollZoom?: boolean | undefined;
|
|
1483
|
+
title?: boolean | undefined;
|
|
1484
|
+
fallback?: boolean | undefined;
|
|
1485
|
+
mapboxGLVersion?: string | undefined;
|
|
1486
|
+
mapboxGLGeocoderVersion?: string | undefined;
|
|
1487
|
+
ownerId?: string | undefined;
|
|
1488
|
+
draft?: string | undefined;
|
|
1486
1489
|
}): MapiRequest;
|
|
1487
1490
|
}
|
|
1488
1491
|
|
|
@@ -1555,20 +1558,20 @@ declare module '@mapbox/mapbox-sdk/services/tilequery' {
|
|
|
1555
1558
|
/**
|
|
1556
1559
|
* The approximate distance in meters to query for features. (optional, default 0)
|
|
1557
1560
|
*/
|
|
1558
|
-
radius?: number;
|
|
1561
|
+
radius?: number | undefined;
|
|
1559
1562
|
/**
|
|
1560
1563
|
* The number of features to return, between 1 and 50. (optional, default 5)
|
|
1561
1564
|
*/
|
|
1562
|
-
limit?: number;
|
|
1565
|
+
limit?: number | undefined;
|
|
1563
1566
|
/**
|
|
1564
1567
|
* Whether or not to deduplicate results. (optional, default true)
|
|
1565
1568
|
*/
|
|
1566
|
-
dedupe?: boolean;
|
|
1569
|
+
dedupe?: boolean | undefined;
|
|
1567
1570
|
/**
|
|
1568
1571
|
* Queries for a specific geometry type.
|
|
1569
1572
|
*/
|
|
1570
|
-
geometry?: GeometryType;
|
|
1571
|
-
layers?: string[];
|
|
1573
|
+
geometry?: GeometryType | undefined;
|
|
1574
|
+
layers?: string[] | undefined;
|
|
1572
1575
|
}
|
|
1573
1576
|
|
|
1574
1577
|
type GeometryType = 'polygon' | 'linestring' | 'point';
|
|
@@ -1586,44 +1589,44 @@ declare module '@mapbox/mapbox-sdk/services/tilesets' {
|
|
|
1586
1589
|
interface TilesetsService {
|
|
1587
1590
|
listTilesets(config: {
|
|
1588
1591
|
ownerId: string;
|
|
1589
|
-
type?: 'raster' | 'vector';
|
|
1590
|
-
limit?: number;
|
|
1591
|
-
sortBy?: 'created' | 'modified';
|
|
1592
|
-
start?: string;
|
|
1593
|
-
visibility?: 'public' | 'private';
|
|
1592
|
+
type?: 'raster' | 'vector' | undefined;
|
|
1593
|
+
limit?: number | undefined;
|
|
1594
|
+
sortBy?: 'created' | 'modified' | undefined;
|
|
1595
|
+
start?: string | undefined;
|
|
1596
|
+
visibility?: 'public' | 'private' | undefined;
|
|
1594
1597
|
}): MapiRequest;
|
|
1595
1598
|
deleteTileset(config: { tilesetId: string }): MapiRequest;
|
|
1596
1599
|
tileJSONMetadata(config: { tilesetId: string }): MapiRequest;
|
|
1597
1600
|
createTilesetSource(config: {
|
|
1598
1601
|
id: string;
|
|
1599
1602
|
file: Blob | ArrayBuffer | string | NodeJS.ReadStream;
|
|
1600
|
-
ownerId?: string;
|
|
1603
|
+
ownerId?: string | undefined;
|
|
1601
1604
|
}): MapiRequest;
|
|
1602
|
-
getTilesetSource(config: { id: string; ownerId?: string }): MapiRequest;
|
|
1603
|
-
listTilesetSources(config: { ownerId?: string; limit?: number; start?: string }): MapiRequest;
|
|
1604
|
-
deleteTilesetSource(config: { id: string; ownerId?: string }): MapiRequest;
|
|
1605
|
+
getTilesetSource(config: { id: string; ownerId?: string | undefined }): MapiRequest;
|
|
1606
|
+
listTilesetSources(config: { ownerId?: string | undefined; limit?: number | undefined; start?: string | undefined }): MapiRequest;
|
|
1607
|
+
deleteTilesetSource(config: { id: string; ownerId?: string | undefined }): MapiRequest;
|
|
1605
1608
|
createTileset(config: {
|
|
1606
1609
|
tilesetId: string;
|
|
1607
1610
|
recipe: any;
|
|
1608
1611
|
name: string;
|
|
1609
|
-
private?: boolean;
|
|
1610
|
-
description?: string;
|
|
1612
|
+
private?: boolean | undefined;
|
|
1613
|
+
description?: string | undefined;
|
|
1611
1614
|
}): MapiRequest;
|
|
1612
1615
|
publishTileset(config: { tilesetId: string }): MapiRequest;
|
|
1613
1616
|
updateTileset(config: {
|
|
1614
1617
|
tilesetId: string;
|
|
1615
|
-
name?: string;
|
|
1616
|
-
description?: string;
|
|
1617
|
-
private?: boolean;
|
|
1618
|
-
attribution?: Array<{ text?: string; link?: string }
|
|
1618
|
+
name?: string | undefined;
|
|
1619
|
+
description?: string | undefined;
|
|
1620
|
+
private?: boolean | undefined;
|
|
1621
|
+
attribution?: Array<{ text?: string | undefined; link?: string | undefined }> | undefined;
|
|
1619
1622
|
}): MapiRequest;
|
|
1620
1623
|
tilesetStatus(config: { tilesetId: string }): MapiRequest;
|
|
1621
1624
|
tilesetJob(config: { tilesetId: string; jobId: string }): MapiRequest;
|
|
1622
1625
|
listTilesetJobs(config: {
|
|
1623
1626
|
tilesetId: string;
|
|
1624
|
-
stage?: 'processing' | 'queued' | 'success' | 'failed';
|
|
1625
|
-
limit?: number;
|
|
1626
|
-
start?: string;
|
|
1627
|
+
stage?: 'processing' | 'queued' | 'success' | 'failed' | undefined;
|
|
1628
|
+
limit?: number | undefined;
|
|
1629
|
+
start?: string | undefined;
|
|
1627
1630
|
}): MapiRequest;
|
|
1628
1631
|
getTilesetsQueue(): MapiRequest;
|
|
1629
1632
|
validateRecipe(config: { recipe: any }): MapiRequest;
|
|
@@ -1730,10 +1733,10 @@ declare module '@mapbox/mapbox-sdk/services/tokens' {
|
|
|
1730
1733
|
}
|
|
1731
1734
|
|
|
1732
1735
|
interface CreateTokenRequest {
|
|
1733
|
-
note?: string;
|
|
1734
|
-
scopes?: string[];
|
|
1735
|
-
resources?: string[];
|
|
1736
|
-
allowedUrls?: string[];
|
|
1736
|
+
note?: string | undefined;
|
|
1737
|
+
scopes?: string[] | undefined;
|
|
1738
|
+
resources?: string[] | undefined;
|
|
1739
|
+
allowedUrls?: string[] | undefined;
|
|
1737
1740
|
}
|
|
1738
1741
|
|
|
1739
1742
|
interface TemporaryTokenRequest {
|
|
@@ -1771,7 +1774,7 @@ declare module '@mapbox/mapbox-sdk/services/uploads' {
|
|
|
1771
1774
|
* List the statuses of all recent uploads.
|
|
1772
1775
|
* @param config
|
|
1773
1776
|
*/
|
|
1774
|
-
listUploads(config?: { reverse?: boolean }): MapiRequest;
|
|
1777
|
+
listUploads(config?: { reverse?: boolean | undefined }): MapiRequest;
|
|
1775
1778
|
/**
|
|
1776
1779
|
* Create S3 credentials.
|
|
1777
1780
|
*/
|
|
@@ -1780,7 +1783,7 @@ declare module '@mapbox/mapbox-sdk/services/uploads' {
|
|
|
1780
1783
|
* Create an upload.
|
|
1781
1784
|
* @param config
|
|
1782
1785
|
*/
|
|
1783
|
-
createUpload(config: { tileset: string; url: string; name?: string }): MapiRequest;
|
|
1786
|
+
createUpload(config: { tileset: string; url: string; name?: string | undefined }): MapiRequest;
|
|
1784
1787
|
/**
|
|
1785
1788
|
* Get an upload's status.
|
|
1786
1789
|
* @param config
|
mapbox__mapbox-sdk/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/mapbox__mapbox-sdk",
|
|
3
|
-
"version": "0.13.
|
|
3
|
+
"version": "0.13.3",
|
|
4
4
|
"description": "TypeScript definitions for @mapbox/mapbox-sdk",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mapbox__mapbox-sdk",
|
|
6
6
|
"license": "MIT",
|
|
@@ -42,9 +42,8 @@
|
|
|
42
42
|
"dependencies": {
|
|
43
43
|
"@types/geojson": "*",
|
|
44
44
|
"@types/mapbox-gl": "*",
|
|
45
|
-
"@types/mapbox__mapbox-sdk": "*",
|
|
46
45
|
"@types/node": "*"
|
|
47
46
|
},
|
|
48
|
-
"typesPublisherContentHash": "
|
|
49
|
-
"typeScriptVersion": "3.
|
|
47
|
+
"typesPublisherContentHash": "a187dca402af20e5fc089bc696726b296d07ac88c9b8e7aede7355686c33eee0",
|
|
48
|
+
"typeScriptVersion": "3.9"
|
|
50
49
|
}
|