Skip to content

docs: typedoc deprecation for showStopSigns and showTrafficLights #486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 9, 2025
Merged

docs: typedoc deprecation for showStopSigns and showTrafficLights #486

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/navigation/navigation/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,20 @@ export interface DisplayOptions {
* If true, destination markers are shown.
*/
showDestinationMarkers?: boolean;

/**
* @deprecated Stop signs are enabled by default and this option will be removed in a future release.
*
* Configures whether stop signs are shown during navigation.
* If true, stop signs are shown.
*
* Defaults to true.
*/
showStopSigns?: boolean;

/**
* @deprecated Traffic lights are enabled by default and this option will be removed in a future release.
*
* Configures whether traffic lights are shown during navigation.
* If true, traffic lights are shown.
*
Expand Down Expand Up @@ -124,6 +130,7 @@ export interface ArrivalEvent {
* Waypoint the device has arrived to. This waypoint was used when setDestinations was called.
*/
waypoint: Waypoint;

/** Whether this is the last waypoint to be visited in the route */
isFinalDestination?: boolean;
}
Expand Down
Loading