Interface: NearestSubscription<T>

Defined in: src/sdk/navigation/NearestSubscription.ts:34

A nearest search which provides its search results as an array of facilities. The contents of the array are automatically updated when the search is updated.

Extends

• SubscribableArray<T>

Type Parameters

Type Parameter
T extends Facility

Properties

length

readonly length: number

Defined in: src/sdk/sub/SubscribableArray.ts:27

The length of this array.

Inherited from

SubscribableArray.length

---

start()

start: () => Promise<void>

Defined in: src/sdk/navigation/NearestSubscription.ts:40

Starts this search.

Returns

Promise<void>

---

started

readonly started: boolean

Defined in: src/sdk/navigation/NearestSubscription.ts:36

Whether this search has started.

---

update()

update: (lat, lon, radius, maxItems) => Promise<void>

Defined in: src/sdk/navigation/NearestSubscription.ts:50

Updates this search with new parameters. If an update is already in progress, this method will wait until the existing update is finished and then fulfill its returned Promise immediately.

Parameters

Parameter	Type	Description
lat	number	The latitude, in degrees, of the center of the search.
lon	number	The longitude, in degrees, of the center of the search.
radius	number	The radius of the search, in meters.
maxItems	number	The maximum number of items to return from the search.

Returns

Promise<void>

A Promise which will be fulfilled when the update is complete.

Methods

awaitStart()

awaitStart(): Promise<void>

Defined in: src/sdk/navigation/NearestSubscription.ts:38

Waits until this search has started.

Returns

Promise<void>

---

get()

get(index): T

Defined in: src/sdk/sub/SubscribableArray.ts:35

Retrieves an element from this array.

Parameters

Parameter	Type	Description
index	number	The index of the element.

Returns

T

the element at the specified index.

Throws

Error if index is out of bounds.

Inherited from

SubscribableArray.get

---

getArray()

getArray(): readonly T[]

Defined in: src/sdk/sub/SubscribableArray.ts:48

Gets a read-only version of this array.

Returns

readonly T[]

a read-only version of this array.

Inherited from

SubscribableArray.getArray

---

sub()

sub(handler, initialNotify?, paused?): Subscription

Defined in: src/sdk/sub/SubscribableArray.ts:58

Subscribes to changes in this array's state.

Parameters

Parameter	Type	Description
handler	SubscribableArrayHandler<T>	A function which is called when this array's state changes.
initialNotify?	boolean	Whether to immediately invoke the callback function with this array's current state. Defaults to false. This argument is ignored if the subscription is initialized as paused.
paused?	boolean	Whether the new subscription should be initialized as paused. Defaults to false.

Returns

Subscription

The new subscription.

Inherited from

SubscribableArray.sub

---

tryGet()

tryGet(index): undefined | T

Defined in: src/sdk/sub/SubscribableArray.ts:42

Attempts to retrieve an element from this array.

Parameters

Parameter	Type	Description
index	number	The index of the element.

Returns

undefined | T

the element at the specified index, or undefined if index is out of bounds.

Inherited from

SubscribableArray.tryGet

---

unsub()

unsub(handler): void

Defined in: src/sdk/sub/SubscribableArray.ts:66

Unsubscribes a callback function from this array.

Parameters

Parameter	Type	Description
handler	SubscribableArrayHandler<T>	The function to unsubscribe.

Returns

void

Deprecated

This method has been deprecated in favor of using the Subscription object returned by .sub() to manage subscriptions.

Inherited from

SubscribableArray.unsub