Type Alias RouteProfile

Type Declaration

• { costing?: "auto"; costing_options?: never }

  • Optionalcosting?: "auto"

    Driving is the default when omitted.

  • Optionalcosting_options?: never

    Driving tuning is not exposed.

• {
      costing: "bicycle";
      costing_options?: {
          bicycle: BicycleCostingOptions;
          pedestrian?: never;
          truck?: never;
      };
  }

  • costing: "bicycle"

    Cycling profile.

  • Optionalcosting_options?: { bicycle: BicycleCostingOptions; pedestrian?: never; truck?: never }

    Only bicycle options are accepted.

    • bicycle: BicycleCostingOptions

      Bicycle settings for this route.

    • Optionalpedestrian?: never

      Walking settings cannot be used for cycling.

    • Optionaltruck?: never

      Truck settings cannot be used for cycling.

• {
      costing: "pedestrian";
      costing_options?: {
          bicycle?: never;
          pedestrian: PedestrianCostingOptions;
          truck?: never;
      };
  }

  • costing: "pedestrian"

    Walking profile.

  • Optionalcosting_options?: { bicycle?: never; pedestrian: PedestrianCostingOptions; truck?: never }

    Only pedestrian options are accepted.

    • Optionalbicycle?: never

      Bicycle settings cannot be used for walking.

    • pedestrian: PedestrianCostingOptions

      Walking settings for this route.

    • Optionaltruck?: never

      Truck settings cannot be used for walking.

• {
      costing: "truck";
      costing_options?: {
          bicycle?: never;
          pedestrian?: never;
          truck: TruckCostingOptions;
      };
  }

  • costing: "truck"

    Truck profile.

  • Optionalcosting_options?: { bicycle?: never; pedestrian?: never; truck: TruckCostingOptions }

    Only truck options are accepted.

    • Optionalbicycle?: never

      Bicycle settings cannot be used for truck routing.

    • Optionalpedestrian?: never

      Walking settings cannot be used for truck routing.

    • truck: TruckCostingOptions

      Vehicle attributes for this route.