Skip to main content

Class: FacilityWaypointUtils

A utility class for working with FacilityWaypoint.

Constructors

constructor

new FacilityWaypointUtils(): FacilityWaypointUtils

Returns

FacilityWaypointUtils

Methods

isFacilityWaypoint

isFacilityWaypoint(waypoint): waypoint is FacilityWaypoint<Facility>

Checks whether a waypoint is a FacilityWaypoint.

Parameters

NameTypeDescription
waypointWaypointThe waypoint to check.

Returns

waypoint is FacilityWaypoint<Facility>

Whether the specified waypoint is a FacilityWaypoint.

Defined in

src/sdk/navigation/Waypoint.ts:227

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

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

Type parameters

NameType
Textends FacilityType

Parameters

NameTypeDescription
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.

Defined in

src/sdk/navigation/Waypoint.ts:234