This is the documentation of version 1.0.0-rc.1. Go to the latest version, 1.0.0-rc.5.

Type Alias VehicleRestrictions

The vehicle parameters for the restrictions applied during route planning.

type VehicleRestrictions = {
    restrictions?: {
        maxSpeedKMH?: number;
        tollTransponder?: TollTransponder;
    };
}

Index

Properties

Properties

`Optional`restrictions

restrictions?: { maxSpeedKMH?: number; tollTransponder?: TollTransponder }

Vehicle restrictions applied during route planning.

Type Declaration

OptionalmaxSpeedKMH?: number

The maximum speed of the vehicle, in kilometres/hour.

It must be in the range [0, 250]. A value of 0 means that route planning determines and applies an appropriate value for the vehicle.
Default
```
0
```
OptionaltollTransponder?: TollTransponder

Whether the vehicle carries an electronic toll collection transponder.
Remarks
It affects which toll roads are considered usable. A toll that can only be paid by transponder is avoided when this is none, and a toll that cannot be paid by transponder is avoided when this is all.
Default
```
'unknown'
```
Example
```
restrictions: {
  tollTransponder: 'all'
}
```