Class: AbstractSubscribableArray<T>

An array-like class to observe changes in a list of objects. ArraySubject

Type parameters

Name
T

Hierarchy

• AbstractSubscribableArray

  ↳ AbstractNearestSubscription

  ↳ AdaptiveNearestSubscription

  ↳ ArraySubject

  ↳ SortedMappedSubscribableArray

  ↳ FilteredMappedSubscribableArray

Implements

• SubscribableArray<T>

Constructors

constructor

• new AbstractSubscribableArray<T>(): AbstractSubscribableArray<T>

Type parameters

Name
T

Returns

AbstractSubscribableArray<T>

Properties

initialNotifyFunc

• Protected Readonly initialNotifyFunc: (sub: HandlerSubscription<SubscribableArrayHandler<T>>) => void

A function which sends initial notifications to subscriptions.

Type declaration

▸ (sub): void

A function which sends initial notifications to subscriptions.

Parameters

Name	Type
sub	HandlerSubscription<SubscribableArrayHandler<T>>

Returns

void

Defined in

src/sdk/sub/AbstractSubscribableArray.ts:20

---

length

• Readonly Abstract length: number

The length of this array.

Implementation of

SubscribableArray.length

Defined in

src/sdk/sub/AbstractSubscribableArray.ts:12

---

notifyDepth

• Protected notifyDepth: number = 0

Defined in

src/sdk/sub/AbstractSubscribableArray.ts:17

---

onSubDestroyedFunc

• Protected Readonly onSubDestroyedFunc: (sub: HandlerSubscription<SubscribableArrayHandler<T>>) => void

A function which responds to when a subscription to this subscribable is destroyed.

Type declaration

▸ (sub): void

A function which responds to when a subscription to this subscribable is destroyed.

Parameters

Name	Type
sub	HandlerSubscription<SubscribableArrayHandler<T>>

Returns

void

Defined in

src/sdk/sub/AbstractSubscribableArray.ts:23

---

singletonSub

• Protected Optional singletonSub: HandlerSubscription<SubscribableArrayHandler<T>>

Defined in

src/sdk/sub/AbstractSubscribableArray.ts:14

---

subs

• Protected Optional subs: HandlerSubscription<SubscribableArrayHandler<T>>[]

Defined in

src/sdk/sub/AbstractSubscribableArray.ts:16

Methods

addSubscription

▸ addSubscription(sub): void

Adds a subscription to this array.

Parameters

Name	Type	Description
sub	HandlerSubscription<SubscribableArrayHandler<T>>	The subscription to add.

Returns

void

Defined in

src/sdk/sub/AbstractSubscribableArray.ts:29

---

get

▸ get(index): T

Gets an item from the array.

Parameters

Name	Type	Description
index	number	Thex index of the item to get.

Returns

T

An item.

Throws

Implementation of

SubscribableArray.get

Defined in

src/sdk/sub/AbstractSubscribableArray.ts:77

---

getArray

▸ getArray(): readonly T[]

Gets a read-only version of this array.

Returns

readonly T[]

a read-only version of this array.

Implementation of

SubscribableArray.getArray

Defined in

src/sdk/sub/AbstractSubscribableArray.ts:69

---

initialNotify

▸ initialNotify(sub): void

Notifies a subscription of this array's current state.

Parameters

Name	Type	Description
sub	HandlerSubscription<SubscribableArrayHandler<T>>	The subscription to notify.

Returns

void

Defined in

src/sdk/sub/AbstractSubscribableArray.ts:176

---

notify

▸ notify(index, type, modifiedItem?): void

Notifies subscriptions of a change in the array.

Parameters

Name	Type	Description
index	number	The index that was changed.
type	SubscribableArrayEventType	The type of subject event.
modifiedItem?	T | readonly T[]	The item modified by the operation.

Returns

void

Defined in

src/sdk/sub/AbstractSubscribableArray.ts:100

---

onSubDestroyed

▸ onSubDestroyed(sub): void

Responds to when a subscription to this array is destroyed.

Parameters

Name	Type	Description
sub	HandlerSubscription<SubscribableArrayHandler<T>>	The destroyed subscription.

Returns

void

Defined in

src/sdk/sub/AbstractSubscribableArray.ts:185

---

sub

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

Subscribes to changes in this array's state.

Parameters

Name	Type	Default value	Description
handler	SubscribableArrayHandler<T>	undefined	A function which is called when this array's state changes.
initialNotify	boolean	false	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	false	Whether the new subscription should be initialized as paused. Defaults to false.

Returns

Subscription

The new subscription.

Implementation of

SubscribableArray.sub

Defined in

src/sdk/sub/AbstractSubscribableArray.ts:41

---

tryGet

▸ tryGet(index): undefined | T

Tries to get the value from the array.

Parameters

Name	Type	Description
index	number	The index of the item to get.

Returns

undefined | T

The value or undefined if not found.

Implementation of

SubscribableArray.tryGet

Defined in

src/sdk/sub/AbstractSubscribableArray.ts:90

---

unsub

▸ unsub(handler): void

Unsubscribes a callback function from this array.

Parameters

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

Implementation of

SubscribableArray.unsub

Defined in

src/sdk/sub/AbstractSubscribableArray.ts:56