Class RoutingService

Service for calculating routes between coordinates using Cercalia API.

Remarks

Supports multiple vehicle types, optimization criteria, truck restrictions, and waypoint reordering for logistics applications.

Hierarchy (View Summary)

CercaliaClient
- RoutingService

Index

Constructors

Properties

Methods

calculateRoute getDistanceTime request

Constructors

constructor

new RoutingService(config: CercaliaConfig): RoutingService
Creates a new Cercalia client instance.
Parameters
- config: CercaliaConfig
  The Cercalia API configuration.
Returns RoutingService
Inherited from CercaliaClient.constructor
- Defined in services/cercalia-client.ts:46

Properties

`Protected`config

config: CercaliaConfig

Configuration for the Cercalia API connection.

Methods

calculateRoute

calculateRoute(
    origin: Coordinate,
    destination: Coordinate,
    options?: RoutingOptions & { waypoints?: Coordinate[] },
): Promise<RouteResult>
Calculates a route between two points.
Parameters
- origin: Coordinate
  Starting coordinate.
- destination: Coordinate
  Ending coordinate.
- Optionaloptions: RoutingOptions & { waypoints?: Coordinate[] }
  Routing options including vehicle type, weight, and waypoints.
Returns Promise<RouteResult>
Promise resolving to route result with distance, duration, and geometry.
Throws
Error if no route is found.
Example
```
const routing = new RoutingService(config);
const route = await routing.calculateRoute(
  { lat: 41.3851, lng: 2.1734 }, // Barcelona
  { lat: 40.4168, lng: -3.7038 }  // Madrid
);

logger.info(route.distance); // Distance in meters
logger.info(route.duration); // Duration in seconds
logger.info(route.wkt); // WKT geometry of the route
```
- Defined in services/routing.service.ts:55

getDistanceTime

getDistanceTime(
    origin: Coordinate,
    destination: Coordinate,
    vehicleType?: VehicleType,
): Promise<{ distance: number; duration: number }>
Gets distance and time between two points without full route geometry.
Parameters
- origin: Coordinate
  Starting coordinate.
- destination: Coordinate
  Ending coordinate.
- OptionalvehicleType: VehicleType
  Optional vehicle type for routing preferences.
Returns Promise<{ distance: number; duration: number }>
Promise resolving to distance in meters and duration in seconds.
Throws
Error if no route is found.
Example
```
const { distance, duration } = await routing.getDistanceTime(
  { lat: 41.3851, lng: 2.1734 },
  { lat: 41.3888, lng: 2.1590 }
);

logger.info(`${distance}m in ${duration}s`); // e.g., "2500m in 450s"
```
- Defined in services/routing.service.ts:156

`Protected`request

request<T>(
    params: Record<string, string>,
    operationName?: string,
    baseUrl?: string,
): Promise<T>
Executes a generic request to the Cercalia API.
Type Parameters
- T
Parameters
- params: Record<string, string>
  Query parameters for the API request.
- operationName: string = 'Cercalia Request'
  Human-readable name for logging and debugging.
- OptionalbaseUrl: string
  Optional override for the base API URL.
Returns Promise<T>
A promise resolving to the parsed API response.
Throws
Error with code '30006' when no results are found.

Throws
Error for HTTP errors or invalid JSON responses.
Example
```
const response = await this.request<MyResponse>(
  { cmd: 'cand', adr: 'Gran Via 1' },
  'Geocoding'
);
```
Inherited from CercaliaClient.request
- Defined in services/cercalia-client.ts:68