Class: AbstractSubscribable<T>

An abstract implementation of a subscribable which allows adding, removing, and notifying subscribers.

Type parameters

Name
T

Hierarchy

• AbstractSubscribable

  ↳ ConsumerSubject

  ↳ GeoPointSubject

  ↳ BasicNavAngleSubject

  ↳ CssTransformSubject

  ↳ NumberUnitSubject

  ↳ Vec2Subject

  ↳ Vec3Subject

  ↳ VecNSubject

  ↳ ProxiedPerformancePlanProperty

  ↳ CombinedSubject

  ↳ MappedSubject

  ↳ Subject

Implements

• Subscribable<T>

Constructors

constructor

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

Type parameters

Name
T

Returns

AbstractSubscribable<T>

Properties

initialNotifyFunc

• Protected Readonly initialNotifyFunc: (sub: HandlerSubscription<(v: T) => void>) => 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<(v: T) => void>

Returns

void

Defined in

src/sdk/sub/AbstractSubscribable.ts:26

---

isSubscribable

• Readonly isSubscribable: true

Flags this object as a Subscribable.

Implementation of

Subscribable.isSubscribable

Defined in

src/sdk/sub/AbstractSubscribable.ts:10

---

notifyDepth

• Protected notifyDepth: number = 0

Defined in

src/sdk/sub/AbstractSubscribable.ts:23

---

onSubDestroyedFunc

• Protected Readonly onSubDestroyedFunc: (sub: HandlerSubscription<(v: T) => void>) => 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<(v: T) => void>

Returns

void

Defined in

src/sdk/sub/AbstractSubscribable.ts:29

---

singletonSub

• Protected Optional singletonSub: HandlerSubscription<(v: T) => void>

Defined in

src/sdk/sub/AbstractSubscribable.ts:20

---

subs

• Protected Optional subs: HandlerSubscription<(v: T) => void>[]

Defined in

src/sdk/sub/AbstractSubscribable.ts:22

Methods

addSubscription

▸ addSubscription(sub): void

Adds a subscription to this subscribable.

Parameters

Name	Type	Description
sub	HandlerSubscription<(v: T) => void>	The subscription to add.

Returns

void

Defined in

src/sdk/sub/AbstractSubscribable.ts:35

---

get

▸ get(): T

Gets this item's state.

Returns

T

This item's state.

Implementation of

Subscribable.get

Defined in

src/sdk/sub/AbstractSubscribable.ts:47

---

map

▸ map<M>(fn, equalityFunc?): MappedSubscribable<M>

Maps this subscribable to a new subscribable.

Type parameters

Name
M

Parameters

Name	Type	Description
fn	(input: T, previousVal?: M) => M	The function to use to map to the new subscribable.
equalityFunc?	(a: M, b: M) => boolean	The function to use to check for equality between mapped values. Defaults to the strict equality comparison (===).

Returns

MappedSubscribable<M>

The mapped subscribable.

Implementation of

Subscribable.map

Defined in

src/sdk/sub/AbstractSubscribable.ts:186

▸ map<M>(fn, equalityFunc, mutateFunc, initialVal): MappedSubscribable<M>

Maps this subscribable to a new subscribable with a persistent, cached value which is mutated when it changes.

Type parameters

Name
M

Parameters

Name	Type	Description
fn	(input: T, previousVal?: M) => M	The function to use to map to the new subscribable.
equalityFunc	(a: M, b: M) => boolean	The function to use to check for equality between mapped values.
mutateFunc	(oldVal: M, newVal: M) => void	The function to use to change the value of the mapped subscribable.
initialVal	M	The initial value of the mapped subscribable.

Returns

MappedSubscribable<M>

The mapped subscribable.

Implementation of

Subscribable.map

Defined in

src/sdk/sub/AbstractSubscribable.ts:195

---

notify

▸ notify(): void

Notifies subscriptions that this subscribable's value has changed.

Returns

void

Defined in

src/sdk/sub/AbstractSubscribable.ts:80

---

notifySubscription

▸ notifySubscription(sub): void

Notifies a subscription of this subscribable's current state.

Parameters

Name	Type	Description
sub	HandlerSubscription<(v: T) => void>	The subscription to notify.

Returns

void

Defined in

src/sdk/sub/AbstractSubscribable.ts:156

---

onSubDestroyed

▸ onSubDestroyed(sub): void

Responds to when a subscription to this subscribable is destroyed.

Parameters

Name	Type	Description
sub	HandlerSubscription<(v: T) => void>	The destroyed subscription.

Returns

void

Defined in

src/sdk/sub/AbstractSubscribable.ts:164

---

pipe

▸ pipe(to, paused?): Subscription

Subscribes to and pipes this subscribable's state to a mutable subscribable. Whenever an update of this subscribable's state is received through the subscription, it will be used as an input to change the other subscribable's state.

Parameters

Name	Type	Description
to	MutableSubscribable<any, T>	The mutable subscribable to which to pipe this subscribable's state.
paused?	boolean	Whether the new subscription should be initialized as paused. Defaults to false.

Returns

Subscription

The new subscription.

Implementation of

Subscribable.pipe

Defined in

src/sdk/sub/AbstractSubscribable.ts:219

▸ pipe<M>(to, map, paused?): Subscription

Subscribes to this subscribable's state and pipes a mapped version to a mutable subscribable. Whenever an update of this subscribable's state is received through the subscription, it will be transformed by the specified mapping function, and the transformed state will be used as an input to change the other subscribable's state.

Type parameters

Name
M

Parameters

Name	Type	Description
to	MutableSubscribable<any, M>	The mutable subscribable to which to pipe this subscribable's mapped state.
map	(fromVal: T, toVal: M) => M	The function to use to transform inputs.
paused?	boolean	Whether the new subscription should be initialized as paused. Defaults to false.

Returns

Subscription

The new subscription.

Implementation of

Subscribable.pipe

Defined in

src/sdk/sub/AbstractSubscribable.ts:229

---

sub

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

Subscribes to changes in this subscribable's state.

Parameters

Name	Type	Default value	Description
handler	(v: T) => void	undefined	A function which is called when this subscribable's state changes.
initialNotify	boolean	false	Whether to immediately invoke the callback function with this subscribable'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

Subscribable.sub

Defined in

src/sdk/sub/AbstractSubscribable.ts:50

---

unsub

▸ unsub(handler): void

Unsubscribes a callback function from this subscribable.

Parameters

Name	Type	Description
handler	(v: T) => void	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

Subscribable.unsub

Defined in

src/sdk/sub/AbstractSubscribable.ts:65

---

DEFAULT_EQUALITY_FUNC

▸ DEFAULT_EQUALITY_FUNC(a, b): boolean

Checks if two values are equal using the strict equality operator.

Parameters

Name	Type	Description
a	any	The first value.
b	any	The second value.

Returns

boolean

whether a and b are equal.

Defined in

src/sdk/sub/AbstractSubscribable.ts:18