@2gis/mapgl-directions - npm Package Compare versions

Comparing version 1.4.0 to 1.5.0

dist/docs.json

@@ -1,1 +0,1 @@
-{"typescript":{"Evented":{"documentation":{"contents":["<p>Event emitter</p>\n"],"contentsRaw":"Event emitter","metadata":{}},"fileName":"src/evented.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"class","name":"Evented","methods":[{"fileName":"src/evented.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"emit","signatures":[{"documentation":{"contents":["<p>Calls all event listeners with event type <code>type</code></p>\n"],"contentsRaw":"Calls all event listeners with event type `type`","metadata":{}},"fileName":"src/evented.ts","kind":"signature","name":"emit","parameters":[{"documentation":{"contents":["<p>Event type</p>\n"],"contentsRaw":"Event type","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"type","type":"K"},{"documentation":{"contents":["<p>Data transferred to events</p>\n"],"contentsRaw":"Data transferred to events","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"data","type":"M[K]"}],"returnType":"this","type":"(type: K, data?: M[K]) => this"}]},{"fileName":"src/evented.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"off","signatures":[{"documentation":{"contents":["<p>Removes event listener registered with <code>on</code></p>\n"],"contentsRaw":"Removes event listener registered with `on`","metadata":{}},"fileName":"src/evented.ts","kind":"signature","name":"off","parameters":[{"documentation":{"contents":["<p>Event type</p>\n"],"contentsRaw":"Event type","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"type","type":"K"},{"documentation":{"contents":["<p>Event handler</p>\n"],"contentsRaw":"Event handler","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"listener","type":"(ev: M[K]) => void"}],"returnType":"this","type":"(type: K, listener: (ev: M[K]) => void) => this"}]},{"fileName":"src/evented.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"on","signatures":[{"documentation":{"contents":["<p>Registers event listener</p>\n"],"contentsRaw":"Registers event listener","metadata":{}},"fileName":"src/evented.ts","kind":"signature","name":"on","parameters":[{"documentation":{"contents":["<p>Event type</p>\n"],"contentsRaw":"Event type","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"type","type":"K"},{"documentation":{"contents":["<p>Event handler</p>\n"],"contentsRaw":"Event handler","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"listener","type":"(ev: M[K]) => void"}],"returnType":"this","type":"(type: K, listener: (ev: M[K]) => void) => this"}]},{"fileName":"src/evented.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"once","signatures":[{"documentation":{"contents":["<p>Registers event listener which will be called once</p>\n"],"contentsRaw":"Registers event listener which will be called once","metadata":{}},"fileName":"src/evented.ts","kind":"signature","name":"once","parameters":[{"documentation":{"contents":["<p>Event type</p>\n"],"contentsRaw":"Event type","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"type","type":"K"},{"documentation":{"contents":["<p>Event handler</p>\n"],"contentsRaw":"Event handler","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"listener","type":"(ev: M[K]) => void"}],"returnType":"this","type":"(type: K, listener: (ev: M[K]) => void) => this"}]}],"properties":[],"accessors":[],"constructorType":{"fileName":"src/evented.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"constructor","name":"constructor","signatures":[{"fileName":"src/evented.ts","kind":"signature","name":"new Evented","parameters":[],"returnType":"Evented","type":"() => Evented"}]}},"Directions":{"documentation":{"contents":["<p>A class that provides driving direction functionality.</p>\n"],"contentsRaw":"A class that provides driving direction functionality.","metadata":{}},"fileName":"src/directions.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"class","name":"Directions","extends":["Evented<DirectionsEventTable>"],"methods":[{"fileName":"src/directions.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"carRoute","signatures":[{"documentation":{"contents":["<p>Finds and draws an optimal car route.</p>\n"],"contentsRaw":"Finds and draws an optimal car route.","metadata":{}},"fileName":"src/directions.ts","kind":"signature","name":"carRoute","parameters":[{"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"options","type":"CarRouteOptions"}],"returnType":"Promise<void>","type":"(options: CarRouteOptions) => Promise<void>"}]},{"fileName":"src/directions.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"clear","signatures":[{"documentation":{"contents":["<p>Clears the map from any previously drawn routes.</p>\n"],"contentsRaw":"Clears the map from any previously drawn routes.","metadata":{}},"fileName":"src/directions.ts","kind":"signature","name":"clear","parameters":[],"returnType":"void","type":"() => void"}]},{"fileName":"src/evented.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"emit","inheritedFrom":"Evented.emit","signatures":[{"documentation":{"contents":["<p>Calls all event listeners with event type <code>type</code></p>\n"],"contentsRaw":"Calls all event listeners with event type `type`","metadata":{}},"fileName":"src/evented.ts","kind":"signature","name":"emit","parameters":[{"documentation":{"contents":["<p>Event type</p>\n"],"contentsRaw":"Event type","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"type","type":"K"},{"documentation":{"contents":["<p>Data transferred to events</p>\n"],"contentsRaw":"Data transferred to events","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"data","type":"DirectionsEventTable[K]"}],"returnType":"this","type":"(type: K, data?: DirectionsEventTable[K]) => this"}]},{"fileName":"src/evented.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"off","inheritedFrom":"Evented.off","signatures":[{"documentation":{"contents":["<p>Removes event listener registered with <code>on</code></p>\n"],"contentsRaw":"Removes event listener registered with `on`","metadata":{}},"fileName":"src/evented.ts","kind":"signature","name":"off","parameters":[{"documentation":{"contents":["<p>Event type</p>\n"],"contentsRaw":"Event type","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"type","type":"K"},{"documentation":{"contents":["<p>Event handler</p>\n"],"contentsRaw":"Event handler","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"listener","type":"(ev: DirectionsEventTable[K]) => void"}],"returnType":"this","type":"(type: K, listener: (ev: DirectionsEventTable[K]) => void) => this"}]},{"fileName":"src/evented.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"on","inheritedFrom":"Evented.on","signatures":[{"documentation":{"contents":["<p>Registers event listener</p>\n"],"contentsRaw":"Registers event listener","metadata":{}},"fileName":"src/evented.ts","kind":"signature","name":"on","parameters":[{"documentation":{"contents":["<p>Event type</p>\n"],"contentsRaw":"Event type","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"type","type":"K"},{"documentation":{"contents":["<p>Event handler</p>\n"],"contentsRaw":"Event handler","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"listener","type":"(ev: DirectionsEventTable[K]) => void"}],"returnType":"this","type":"(type: K, listener: (ev: DirectionsEventTable[K]) => void) => this"}]},{"fileName":"src/evented.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"once","inheritedFrom":"Evented.once","signatures":[{"documentation":{"contents":["<p>Registers event listener which will be called once</p>\n"],"contentsRaw":"Registers event listener which will be called once","metadata":{}},"fileName":"src/evented.ts","kind":"signature","name":"once","parameters":[{"documentation":{"contents":["<p>Event type</p>\n"],"contentsRaw":"Event type","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"type","type":"K"},{"documentation":{"contents":["<p>Event handler</p>\n"],"contentsRaw":"Event handler","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"listener","type":"(ev: DirectionsEventTable[K]) => void"}],"returnType":"this","type":"(type: K, listener: (ev: DirectionsEventTable[K]) => void) => this"}]},{"fileName":"src/directions.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"pedestrianRoute","signatures":[{"documentation":{"contents":["<p>Finds and draws an optimal pedestrian route.</p>\n"],"contentsRaw":"Finds and draws an optimal pedestrian route.","metadata":{}},"fileName":"src/directions.ts","kind":"signature","name":"pedestrianRoute","parameters":[{"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"options","type":"PedestrianRouteOptions"}],"returnType":"Promise<void>","type":"(options: PedestrianRouteOptions) => Promise<void>"}]}],"properties":[],"accessors":[],"constructorType":{"documentation":{"contents":["<p>Example:</p>\n<pre><code class=\"language-js\">const directions = new mapgl.Directions(map, {\n    directionsApiKey: &#39;Your Directions API access key&#39;,\n});\n\ndirections.carRoute({\n    points: [\n        [55.2772379, 25.2377810],\n        [55.2986956, 25.2576546],\n    ],\n});</code></pre>\n"],"contentsRaw":"Example:\n```js\nconst directions = new mapgl.Directions(map, {\n    directionsApiKey: 'Your Directions API access key',\n});\n\ndirections.carRoute({\n    points: [\n        [55.2772379, 25.2377810],\n        [55.2986956, 25.2576546],\n    ],\n});\n```","metadata":{}},"fileName":"src/directions.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"constructor","name":"constructor","signatures":[{"documentation":{"contents":["<p>Example:</p>\n<pre><code class=\"language-js\">const directions = new mapgl.Directions(map, {\n    directionsApiKey: &#39;Your Directions API access key&#39;,\n});\n\ndirections.carRoute({\n    points: [\n        [55.2772379, 25.2377810],\n        [55.2986956, 25.2576546],\n    ],\n});</code></pre>\n"],"contentsRaw":"Example:\n```js\nconst directions = new mapgl.Directions(map, {\n    directionsApiKey: 'Your Directions API access key',\n});\n\ndirections.carRoute({\n    points: [\n        [55.2772379, 25.2377810],\n        [55.2986956, 25.2576546],\n    ],\n});\n```","metadata":{}},"fileName":"src/directions.ts","kind":"signature","name":"new Directions","parameters":[{"documentation":{"contents":["<p>The map instance.</p>\n"],"contentsRaw":"The map instance.","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"map","type":"mapgl.Map"},{"documentation":{"contents":["<p>Directions initialization options.</p>\n"],"contentsRaw":"Directions initialization options.","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"options","type":"DirectionsOptions"}],"returnType":"Directions","type":"(map: mapgl.Map, options: DirectionsOptions) => Directions"}]}},"DirectionsOptions":{"documentation":{"contents":["<p>Directions initialization options.</p>\n"],"contentsRaw":"Directions initialization options.","metadata":{}},"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"interface","name":"DirectionsOptions","methods":[],"properties":[{"documentation":{"contents":["<p>Directions API access key.</p>\n"],"contentsRaw":"Directions API access key.","metadata":{}},"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"directionsApiKey","type":"string"}]},"CarRouteOptions":{"documentation":{"contents":["<p>Car route method options.</p>\n"],"contentsRaw":"Car route method options.","metadata":{}},"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"interface","name":"CarRouteOptions","methods":[],"properties":[{"documentation":{"contents":["<p>Array of geographical points [longitude, latitude].</p>\n<p>You can set up to 10 points.</p>\n"],"contentsRaw":"Array of geographical points [longitude, latitude].\n\nYou can set up to 10 points.","metadata":{}},"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"points","type":"Point[]"}]},"PedestrianRouteOptions":{"documentation":{"contents":["<p>Pedestrian route method options.</p>\n"],"contentsRaw":"Pedestrian route method options.","metadata":{}},"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"interface","name":"PedestrianRouteOptions","methods":[],"properties":[{"documentation":{"contents":["<p>Array of geographical points [longitude, latitude].</p>\n<p>You can set up to 10 points.</p>\n"],"contentsRaw":"Array of geographical points [longitude, latitude].\n\nYou can set up to 10 points.","metadata":{}},"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"points","type":"Point[]"}]},"DirectionsEventTable":{"documentation":{"contents":["<p>The list of events that can be emitted by a Directions instance.</p>\n"],"contentsRaw":"The list of events that can be emitted by a Directions instance.","metadata":{}},"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"interface","name":"DirectionsEventTable","methods":[],"properties":[{"documentation":{"contents":["<p>Emitted when directions is loaded.</p>\n"],"contentsRaw":"Emitted when directions is loaded.","metadata":{}},"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"directionsLoaded","type":"DirectionsLoadedEvent"}]},"DirectionsLoadedEvent":{"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"interface","name":"DirectionsLoadedEvent","methods":[],"properties":[{"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"routes","type":"PpnaDirection[]"}]},"Point":{"documentation":{"contents":["<p>A geographical point [longitude, latitude].</p>\n"],"contentsRaw":"A geographical point [longitude, latitude].","metadata":{}},"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"type alias","name":"Point","type":"[number, number] | number[]"}}}
+{"typescript":{"Evented":{"documentation":{"contents":["<p>Event emitter</p>\n"],"contentsRaw":"Event emitter","metadata":{}},"fileName":"src/evented.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"class","name":"Evented","methods":[{"fileName":"src/evented.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"emit","signatures":[{"documentation":{"contents":["<p>Calls all event listeners with event type <code>type</code></p>\n"],"contentsRaw":"Calls all event listeners with event type `type`","metadata":{}},"fileName":"src/evented.ts","kind":"signature","name":"emit","parameters":[{"documentation":{"contents":["<p>Event type</p>\n"],"contentsRaw":"Event type","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"type","type":"K"},{"documentation":{"contents":["<p>Data transferred to events</p>\n"],"contentsRaw":"Data transferred to events","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"data","type":"M[K]"}],"returnType":"this","type":"(type: K, data?: M[K]) => this"}]},{"fileName":"src/evented.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"off","signatures":[{"documentation":{"contents":["<p>Removes event listener registered with <code>on</code></p>\n"],"contentsRaw":"Removes event listener registered with `on`","metadata":{}},"fileName":"src/evented.ts","kind":"signature","name":"off","parameters":[{"documentation":{"contents":["<p>Event type</p>\n"],"contentsRaw":"Event type","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"type","type":"K"},{"documentation":{"contents":["<p>Event handler</p>\n"],"contentsRaw":"Event handler","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"listener","type":"(ev: M[K]) => void"}],"returnType":"this","type":"(type: K, listener: (ev: M[K]) => void) => this"}]},{"fileName":"src/evented.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"on","signatures":[{"documentation":{"contents":["<p>Registers event listener</p>\n"],"contentsRaw":"Registers event listener","metadata":{}},"fileName":"src/evented.ts","kind":"signature","name":"on","parameters":[{"documentation":{"contents":["<p>Event type</p>\n"],"contentsRaw":"Event type","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"type","type":"K"},{"documentation":{"contents":["<p>Event handler</p>\n"],"contentsRaw":"Event handler","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"listener","type":"(ev: M[K]) => void"}],"returnType":"this","type":"(type: K, listener: (ev: M[K]) => void) => this"}]},{"fileName":"src/evented.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"once","signatures":[{"documentation":{"contents":["<p>Registers event listener which will be called once</p>\n"],"contentsRaw":"Registers event listener which will be called once","metadata":{}},"fileName":"src/evented.ts","kind":"signature","name":"once","parameters":[{"documentation":{"contents":["<p>Event type</p>\n"],"contentsRaw":"Event type","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"type","type":"K"},{"documentation":{"contents":["<p>Event handler</p>\n"],"contentsRaw":"Event handler","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"listener","type":"(ev: M[K]) => void"}],"returnType":"this","type":"(type: K, listener: (ev: M[K]) => void) => this"}]}],"properties":[],"accessors":[],"constructorType":{"fileName":"src/evented.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"constructor","name":"constructor","signatures":[{"fileName":"src/evented.ts","kind":"signature","name":"new Evented","parameters":[],"returnType":"Evented","type":"() => Evented"}]}},"Directions":{"documentation":{"contents":["<p>A class that provides driving direction functionality.</p>\n"],"contentsRaw":"A class that provides driving direction functionality.","metadata":{}},"fileName":"src/directions.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"class","name":"Directions","extends":["Evented<DirectionsEventTable>"],"methods":[{"fileName":"src/directions.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"carRoute","signatures":[{"documentation":{"contents":["<p>Finds and draws an optimal car route.</p>\n"],"contentsRaw":"Finds and draws an optimal car route.","metadata":{}},"fileName":"src/directions.ts","kind":"signature","name":"carRoute","parameters":[{"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"options","type":"CarRouteOptions"}],"returnType":"Promise<void>","type":"(options: CarRouteOptions) => Promise<void>"}]},{"fileName":"src/directions.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"clear","signatures":[{"documentation":{"contents":["<p>Clears the map from any previously drawn routes.</p>\n"],"contentsRaw":"Clears the map from any previously drawn routes.","metadata":{}},"fileName":"src/directions.ts","kind":"signature","name":"clear","parameters":[],"returnType":"void","type":"() => void"}]},{"fileName":"src/evented.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"emit","inheritedFrom":"Evented.emit","signatures":[{"documentation":{"contents":["<p>Calls all event listeners with event type <code>type</code></p>\n"],"contentsRaw":"Calls all event listeners with event type `type`","metadata":{}},"fileName":"src/evented.ts","kind":"signature","name":"emit","parameters":[{"documentation":{"contents":["<p>Event type</p>\n"],"contentsRaw":"Event type","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"type","type":"K"},{"documentation":{"contents":["<p>Data transferred to events</p>\n"],"contentsRaw":"Data transferred to events","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"data","type":"DirectionsEventTable[K]"}],"returnType":"this","type":"(type: K, data?: DirectionsEventTable[K]) => this"}]},{"fileName":"src/evented.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"off","inheritedFrom":"Evented.off","signatures":[{"documentation":{"contents":["<p>Removes event listener registered with <code>on</code></p>\n"],"contentsRaw":"Removes event listener registered with `on`","metadata":{}},"fileName":"src/evented.ts","kind":"signature","name":"off","parameters":[{"documentation":{"contents":["<p>Event type</p>\n"],"contentsRaw":"Event type","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"type","type":"K"},{"documentation":{"contents":["<p>Event handler</p>\n"],"contentsRaw":"Event handler","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"listener","type":"(ev: DirectionsEventTable[K]) => void"}],"returnType":"this","type":"(type: K, listener: (ev: DirectionsEventTable[K]) => void) => this"}]},{"fileName":"src/evented.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"on","inheritedFrom":"Evented.on","signatures":[{"documentation":{"contents":["<p>Registers event listener</p>\n"],"contentsRaw":"Registers event listener","metadata":{}},"fileName":"src/evented.ts","kind":"signature","name":"on","parameters":[{"documentation":{"contents":["<p>Event type</p>\n"],"contentsRaw":"Event type","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"type","type":"K"},{"documentation":{"contents":["<p>Event handler</p>\n"],"contentsRaw":"Event handler","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"listener","type":"(ev: DirectionsEventTable[K]) => void"}],"returnType":"this","type":"(type: K, listener: (ev: DirectionsEventTable[K]) => void) => this"}]},{"fileName":"src/evented.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"once","inheritedFrom":"Evented.once","signatures":[{"documentation":{"contents":["<p>Registers event listener which will be called once</p>\n"],"contentsRaw":"Registers event listener which will be called once","metadata":{}},"fileName":"src/evented.ts","kind":"signature","name":"once","parameters":[{"documentation":{"contents":["<p>Event type</p>\n"],"contentsRaw":"Event type","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"type","type":"K"},{"documentation":{"contents":["<p>Event handler</p>\n"],"contentsRaw":"Event handler","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"listener","type":"(ev: DirectionsEventTable[K]) => void"}],"returnType":"this","type":"(type: K, listener: (ev: DirectionsEventTable[K]) => void) => this"}]},{"fileName":"src/directions.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"pedestrianRoute","signatures":[{"documentation":{"contents":["<p>Finds and draws an optimal pedestrian route.</p>\n"],"contentsRaw":"Finds and draws an optimal pedestrian route.","metadata":{}},"fileName":"src/directions.ts","kind":"signature","name":"pedestrianRoute","parameters":[{"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"options","type":"PedestrianRouteOptions"}],"returnType":"Promise<void>","type":"(options: PedestrianRouteOptions) => Promise<void>"}]}],"properties":[],"accessors":[],"constructorType":{"documentation":{"contents":["<p>Example:</p>\n<pre><code class=\"language-js\">const directions = new mapgl.Directions(map, {\n    directionsApiKey: &#39;Your Directions API access key&#39;,\n});\n\ndirections.carRoute({\n    points: [\n        [55.2772379, 25.2377810],\n        [55.2986956, 25.2576546],\n    ],\n});</code></pre>\n"],"contentsRaw":"Example:\n```js\nconst directions = new mapgl.Directions(map, {\n    directionsApiKey: 'Your Directions API access key',\n});\n\ndirections.carRoute({\n    points: [\n        [55.2772379, 25.2377810],\n        [55.2986956, 25.2576546],\n    ],\n});\n```","metadata":{}},"fileName":"src/directions.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"constructor","name":"constructor","signatures":[{"documentation":{"contents":["<p>Example:</p>\n<pre><code class=\"language-js\">const directions = new mapgl.Directions(map, {\n    directionsApiKey: &#39;Your Directions API access key&#39;,\n});\n\ndirections.carRoute({\n    points: [\n        [55.2772379, 25.2377810],\n        [55.2986956, 25.2576546],\n    ],\n});</code></pre>\n"],"contentsRaw":"Example:\n```js\nconst directions = new mapgl.Directions(map, {\n    directionsApiKey: 'Your Directions API access key',\n});\n\ndirections.carRoute({\n    points: [\n        [55.2772379, 25.2377810],\n        [55.2986956, 25.2576546],\n    ],\n});\n```","metadata":{}},"fileName":"src/directions.ts","kind":"signature","name":"new Directions","parameters":[{"documentation":{"contents":["<p>The map instance.</p>\n"],"contentsRaw":"The map instance.","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"map","type":"mapgl.Map"},{"documentation":{"contents":["<p>Directions initialization options.</p>\n"],"contentsRaw":"Directions initialization options.","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"options","type":"DirectionsOptions"}],"returnType":"Directions","type":"(map: mapgl.Map, options: DirectionsOptions) => Directions"}]}},"DirectionResult":{"documentation":{"contents":["<p>Result of search for car or pedestrian routing direction.</p>\n"],"contentsRaw":"Result of search for car or pedestrian routing direction.","metadata":{}},"fileName":"src/types/navi.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"interface","name":"DirectionResult","extends":["DirectionBase"],"methods":[],"properties":[{"fileName":"src/types/navi.ts","flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"algorithm","type":"undefined | string"},{"fileName":"src/types/navi.ts","flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"begin_pedestrian_path","type":"PedestrianPath"},{"fileName":"src/types/navi.ts","flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"end_pedestrian_path","type":"PedestrianPath"},{"fileName":"src/types/navi.ts","flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"filter_road_types","type":"DirectionRoadType[]"},{"fileName":"src/types/navi.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"id","inheritedFrom":"DirectionBase.id","type":"string"},{"fileName":"src/types/navi.ts","flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"maneuvers","type":"Maneuver[]"},{"fileName":"src/types/navi.ts","flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"requested_filters","type":"DirectionRoadType[]"},{"fileName":"src/types/navi.ts","flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"result_filters","type":"DirectionRoadType[]"},{"fileName":"src/types/navi.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"route_id","inheritedFrom":"DirectionBase.route_id","type":"string"},{"fileName":"src/types/navi.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"total_distance","type":"number"},{"fileName":"src/types/navi.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"total_duration","inheritedFrom":"DirectionBase.total_duration","type":"number"},{"fileName":"src/types/navi.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"type","type":"\"carrouting\" | \"pedestrianrouting\""},{"fileName":"src/types/navi.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"ui_total_distance","type":""},{"fileName":"src/types/navi.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"ui_total_duration","inheritedFrom":"DirectionBase.ui_total_duration","type":"string"},{"fileName":"src/types/navi.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"waypoints","type":"WayPoint[]"}]},"DirectionsOptions":{"documentation":{"contents":["<p>Directions initialization options.</p>\n"],"contentsRaw":"Directions initialization options.","metadata":{}},"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"interface","name":"DirectionsOptions","methods":[],"properties":[{"documentation":{"contents":["<p>Directions API access key.</p>\n"],"contentsRaw":"Directions API access key.","metadata":{}},"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"directionsApiKey","type":"string"}]},"CarRouteOptions":{"documentation":{"contents":["<p>Car route method options.</p>\n"],"contentsRaw":"Car route method options.","metadata":{}},"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"interface","name":"CarRouteOptions","methods":[],"properties":[{"documentation":{"contents":["<p>Array of geographical points [longitude, latitude].</p>\n<p>You can set up to 10 points.</p>\n"],"contentsRaw":"Array of geographical points [longitude, latitude].\n\nYou can set up to 10 points.","metadata":{}},"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"points","type":"Point[]"}]},"PedestrianRouteOptions":{"documentation":{"contents":["<p>Pedestrian route method options.</p>\n"],"contentsRaw":"Pedestrian route method options.","metadata":{}},"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"interface","name":"PedestrianRouteOptions","methods":[],"properties":[{"documentation":{"contents":["<p>Array of geographical points [longitude, latitude].</p>\n<p>You can set up to 10 points.</p>\n"],"contentsRaw":"Array of geographical points [longitude, latitude].\n\nYou can set up to 10 points.","metadata":{}},"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"points","type":"Point[]"}]},"DirectionsEventTable":{"documentation":{"contents":["<p>The list of events that can be emitted by a Directions instance.</p>\n"],"contentsRaw":"The list of events that can be emitted by a Directions instance.","metadata":{}},"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"interface","name":"DirectionsEventTable","methods":[],"properties":[{"documentation":{"contents":["<p>Emitted when directions is loaded.</p>\n"],"contentsRaw":"Emitted when directions is loaded.","metadata":{}},"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"directionsLoaded","type":"DirectionsLoadedEvent"}]},"DirectionsLoadedEvent":{"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"interface","name":"DirectionsLoadedEvent","methods":[],"properties":[{"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"routes","type":"DirectionResult[]"}]},"Point":{"documentation":{"contents":["<p>A geographical point [longitude, latitude].</p>\n"],"contentsRaw":"A geographical point [longitude, latitude].","metadata":{}},"fileName":"src/types/index.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"type alias","name":"Point","type":"[number, number] | number[]"}}}

dist/types/formatters.d.ts

 import { Point } from './types';
-import { ManeuverOutGeometryColor, PpnaDirection } from './types/navi';
+import { ManeuverOutGeometryColor, DirectionResult } from './types/navi';
 import { PpnaRoute } from './types/formatters';
@@ -23,2 +23,2 @@ import { PpnaPoint } from './types/ppnaDrawer';
  */
-export declare function formatPpnaRoutes(type: 'ppna' | 'pedestrian', directions: PpnaDirection[]): PpnaRoute[];
+export declare function formatPpnaRoutes(type: 'ppna' | 'pedestrian', directions: DirectionResult[]): PpnaRoute[];

dist/types/index.d.ts

 import { Directions } from './directions';
 export { Directions };
 export { DirectionsOptions, CarRouteOptions, PedestrianRouteOptions, DirectionsLoadedEvent, } from './types';
-export { PpnaDirection } from './types/navi';
+export { DirectionResult } from './types/navi';

dist/types/types/index.d.ts

@@ -1,2 +0,2 @@
-import { PpnaDirection } from './navi';
+import { DirectionResult } from './navi';
 /**
@@ -55,3 +55,3 @@ * A geographical point [longitude, latitude].
 export interface DirectionsLoadedEvent {
-    routes: PpnaDirection[];
+    routes: DirectionResult[];
 }

dist/types/types/navi.d.ts

@@ -46,11 +46,5 @@ /**
 /**
- * ППНА и пеший маршруты.
- * Описаны в одном типе, потому что пеший — это ППНА с ограниченным набором маневров с типами: `begin` и `end`.
- *
- * Дока: https://confluence.2gis.ru/pages/viewpage.action?pageId=143464609
- *
- * @hidden
- * @internal
+ * Result of search for car or pedestrian routing direction.
  */
-export interface PpnaDirection extends DirectionBase {
+export interface DirectionResult extends DirectionBase {
     type: 'carrouting' | 'pedestrianrouting';
@@ -57,0 +51,0 @@ algorithm?: string;

package.json

 {
   "name": "@2gis/mapgl-directions",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Driving directions plugin for Mapgl",
@@ -5,0 +5,0 @@ "main": "dist/directions.js",

No alert changes

Improved metrics

Total package byte prevSize

51363

increased by8.75%

Worsened metrics

Lines of code

527

decreased by-1.13%

No dependency changes