@googlemaps/google-maps-services-js
Version:
Node.js client library for Google Maps API Web Services
52 lines (51 loc) • 2.7 kB
TypeScript
/**
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { LatLng, SnappedPoint, RequestParams } from "../common";
import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios";
export interface SnapToRoadsRequest extends Partial<AxiosRequestConfig> {
params: {
/**
* The path to be snapped. The `path` parameter accepts a list of latitude/longitude pairs.
* Latitude and longitude values should be separated by commas. Coordinates should be separated by the pipe character: `"|"`.
* For example: `path=60.170880,24.942795|60.170879,24.942796|60.170877,24.942796`.
*
* **Note:** The snapping algorithm works best for points that are not too far apart.
* If you observe odd snapping behavior, try creating paths that have points closer together.
* To ensure the best snap-to-road quality, you should aim to provide paths on which consecutive pairs
* of points are within 300m of each other. This will also help in handling any isolated, long jumps between
* consecutive points caused by GPS signal loss, or noise.
*/
path: LatLng[];
/**
* Whether to interpolate a path to include all points forming the full road-geometry.
* When true, additional interpolated points will also be returned, resulting in a path that smoothly follows
* the geometry of the road, even around corners and through tunnels.
* Interpolated paths will most likely contain more points than the original path.
*
* @default false
*/
interpolate?: boolean;
} & RequestParams;
}
export interface SnapToRoadsResponse extends AxiosResponse {
data: {
/** An array of snapped points. */
snappedPoints: SnappedPoint[];
};
}
export declare const defaultUrl = "https://roads.googleapis.com/v1/snapToRoads";
export declare const defaultParamsSerializer: (params: Record<string, any>) => string;
export declare function snapToRoads({ params, method, url, paramsSerializer, ...config }: SnapToRoadsRequest, axiosInstance?: AxiosInstance): Promise<SnapToRoadsResponse>;