Skip to main content

Class: FacilityWaypointUtils

Defined in: src/sdk/navigation/Waypoint.ts:221

A utility class for working with FacilityWaypoint.

Constructors

Constructor

new FacilityWaypointUtils(): FacilityWaypointUtils

Returns

FacilityWaypointUtils

Methods

isFacilityWaypoint()

Call Signature

static isFacilityWaypoint(waypoint): waypoint is FacilityWaypoint<Facility>

Defined in: src/sdk/navigation/Waypoint.ts:227

Checks whether a waypoint is a FacilityWaypoint.

Parameters
ParameterTypeDescription
waypointWaypointThe waypoint to check.
Returns

waypoint is FacilityWaypoint<Facility>

Whether the specified waypoint is a FacilityWaypoint.

Call Signature

static isFacilityWaypoint<T>(waypoint, facilityType): waypoint is FacilityWaypoint<FacilityTypeMap[T]>

Defined in: src/sdk/navigation/Waypoint.ts:234

Checks whether a waypoint is a FacilityWaypoint of a given facility type.

Type Parameters
Type Parameter
T extends FacilityType
Parameters
ParameterTypeDescription
waypointWaypointThe waypoint to check.
facilityTypeTThe facility type to check against.
Returns

waypoint is FacilityWaypoint<FacilityTypeMap[T]>

Whether the specified waypoint is a FacilityWaypoint of the specified facility type.