@map.ir/services-sdk/dist/route.d.ts

JavaScript/TypeScript SDK for map.ir services

import type { Route, Waypoint } from "osrm";
import type { LngLat } from "./types";
import type Mapir from "./";
export default function route(this: Mapir, locations: LngLat[], type?: RouteType, options?: IRouteOptions): Promise<IRouteResponse | undefined> | undefined;
export type RouteType = "car" | "walking" | "bicycle";
export interface IRouteOptions extends Record<string, unknown> {
    alternatives?: boolean;
    steps?: boolean;
    overview?: boolean;
}
export type RouteMethod = "GET";
export interface IStaticMapPayload extends Record<string, string> {
    width: `${number}`;
    height: `${number}`;
    markers: `color:${"red" | "blue"}|${number},${number}|${string}`;
    zoom_level: `${number}`;
}
export interface IRouteResponse {
    code: "ok";
    routes: Route[];
    waypoints: Waypoint[];
}