Skip to main content

Interface: NearestSearchSession<TAdded, TRemoved>

Defined in: src/sdk/navigation/FacilityClient.ts:39

A session for searching for nearest facilities.

Extended by​

Type Parameters​

Type Parameter
TAdded
TRemoved

Methods​

searchNearest()​

searchNearest(lat, lon, radius, maxItems): Promise<NearestSearchResults<TAdded, TRemoved>>

Defined in: src/sdk/navigation/FacilityClient.ts:48

Searches for nearest facilities from the specified point.

Parameters​

ParameterTypeDescription
latnumberThe latitude, in degrees.
lonnumberThe longitude, in degrees.
radiusnumberThe radius around the point to search, in meters.
maxItemsnumberThe maximum number of items.

Returns​

Promise<NearestSearchResults<TAdded, TRemoved>>

The nearest search results.