Type Alias Avoidable

Avoidable: typeof avoidableTypes[number]

A route feature that the routing engine tries to avoid when calculating routes.

Use it to customize routes for vehicle capabilities, user preferences or regulatory requirements. Note that avoidance is not guaranteed if no alternative route exists.

Remarks

The avoidance options:

tollRoads: Avoids roads requiring toll payments
motorways: Avoids high-speed limited-access highways (useful for scenic routes or vehicle restrictions)
ferries: Avoids water crossings requiring ferry transport
unpavedRoads: Avoids unpaved/dirt roads (recommended for standard vehicles)
carpools: Avoids carpool/HOV (High Occupancy Vehicle) lanes
alreadyUsedRoads: Prevents using the same road segment multiple times (useful for delivery routes)
borderCrossings: Avoids crossing international borders (useful for customs/visa considerations)
tunnels: Avoids underground tunnels (useful for vehicles carrying hazardous materials)
carTrains: Avoids car train transport segments
lowEmissionZones: Avoids zones with vehicle emission restrictions

Example

// Avoid tolls and motorways for a scenic route
const avoid: Avoidable[] = ['tollRoads', 'motorways'];

// Avoid unpaved roads for a standard car
const avoid: Avoidable[] = ['unpavedRoads'];

Type Alias Avoidable

Remarks

Example

Settings