Skip to main content

Waypoint

type Waypoint = 
  | Position
  | {
  approach?: "unrestricted" | "curb";
  coordinate: Position;
  name?: string;
  silent?: boolean;
};

Defined in: src/Route.ts:22

A coordinate, or a coordinate with options.

Union Members​

Position

Type Literal​

{
  approach?: "unrestricted" | "curb";
  coordinate: Position;
  name?: string;
  silent?: boolean;
}

approach?​

approach?: "unrestricted" | "curb";

curb arrives on the driving side of the road, e.g. the right in right-hand traffic. Defaults to unrestricted, either side.

coordinate​

coordinate: Position;

name?​

name?: string;

Shown by the navigation UI, e.g. on arrival. Ignored on silent waypoints.

silent?​

silent?: boolean;

Pass through without stopping: a silent waypoint doesn't end a leg, so there's no arrival at it. The origin and the destination can't be silent. Defaults to false.