Interface: SubscribableArray<T>
Defined in: src/sdk/sub/SubscribableArray.ts:25
An array which allows others to subscribe to be notified of changes in its state.
Extended by
Type Parameters
| Type Parameter |
|---|
T |
Properties
length
readonlylength:number
Defined in: src/sdk/sub/SubscribableArray.ts:27
The length of this array.
Methods
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.
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.
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
The new subscription.
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.
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.