Skip to content

Commit ab581e5

Browse files
authored
docs: typedoc deprecation for showStopSigns and showTrafficLights (#486)
1 parent d22ed47 commit ab581e5

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/navigation/navigation/types.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,20 @@ export interface DisplayOptions {
7171
* If true, destination markers are shown.
7272
*/
7373
showDestinationMarkers?: boolean;
74+
7475
/**
76+
* @deprecated Stop signs are enabled by default and this option will be removed in a future release.
77+
*
7578
* Configures whether stop signs are shown during navigation.
7679
* If true, stop signs are shown.
7780
*
7881
* Defaults to true.
7982
*/
8083
showStopSigns?: boolean;
84+
8185
/**
86+
* @deprecated Traffic lights are enabled by default and this option will be removed in a future release.
87+
*
8288
* Configures whether traffic lights are shown during navigation.
8389
* If true, traffic lights are shown.
8490
*
@@ -124,6 +130,7 @@ export interface ArrivalEvent {
124130
* Waypoint the device has arrived to. This waypoint was used when setDestinations was called.
125131
*/
126132
waypoint: Waypoint;
133+
127134
/** Whether this is the last waypoint to be visited in the route */
128135
isFinalDestination?: boolean;
129136
}

0 commit comments

Comments
 (0)