Class: MappedSubject<I, T>

A subscribable subject that is a mapped stream from one or more input subscribables.

Type parameters

Name	Type
I	extends any[]
T	T

Hierarchy

• AbstractSubscribable<T>

  ↳ MappedSubject

Implements

• MappedSubscribable<T>

Properties

canInitialNotify

• Readonly canInitialNotify: true

Whether this subscription supports initial notifications on resume.

Implementation of

MappedSubscribable.canInitialNotify

Defined in

src/sdk/sub/MappedSubject.ts:27

---

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

Inherited from

AbstractSubscribable.initialNotifyFunc

Defined in

src/sdk/sub/AbstractSubscribable.ts:26

---

isSubscribable

• Readonly isSubscribable: true

Flags this object as a Subscribable.

Implementation of

MappedSubscribable.isSubscribable

Inherited from

AbstractSubscribable.isSubscribable

Defined in

src/sdk/sub/AbstractSubscribable.ts:10

---

notifyDepth

• Protected notifyDepth: number = 0

Inherited from

AbstractSubscribable.notifyDepth

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

Inherited from

AbstractSubscribable.onSubDestroyedFunc

Defined in

src/sdk/sub/AbstractSubscribable.ts:29

---

singletonSub

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

Inherited from

AbstractSubscribable.singletonSub

Defined in

src/sdk/sub/AbstractSubscribable.ts:20

---

subs

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

Inherited from

AbstractSubscribable.subs

Defined in

src/sdk/sub/AbstractSubscribable.ts:22

Accessors

isAlive

• get isAlive(): boolean

Whether the subscription to the parent subscribable is alive. While alive, this subscribable will update its state based on its parent's state, unless it is paused. Once dead, this subscribable will no longer update its state, and cannot be resumed again.

Returns

boolean

Implementation of

MappedSubscribable.isAlive

Defined in

src/sdk/sub/MappedSubject.ts:39

---

isPaused

• get isPaused(): boolean

Whether the subscription to the parent subscribable is paused. While paused, this subscribable will not update its state until it is resumed.

Returns

boolean

Implementation of

MappedSubscribable.isPaused

Defined in

src/sdk/sub/MappedSubject.ts:45

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

Inherited from

AbstractSubscribable.addSubscription

Defined in

src/sdk/sub/AbstractSubscribable.ts:35

---

destroy

▸ destroy(): void

Destroys the subscription to the parent subscribable.

Returns

void

Implementation of

MappedSubscribable.destroy

Defined in

src/sdk/sub/MappedSubject.ts:216

---

get

▸ get(): T

Gets this item's state.

Returns

T

This item's state.

Implementation of

MappedSubscribable.get

Overrides

AbstractSubscribable.get

Defined in

src/sdk/sub/MappedSubject.ts:170

---

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

MappedSubscribable.map

Inherited from

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

MappedSubscribable.map

Inherited from

AbstractSubscribable.map

Defined in

src/sdk/sub/AbstractSubscribable.ts:195

---

notify

▸ notify(): void

Notifies subscriptions that this subscribable's value has changed.

Returns

void

Inherited from

AbstractSubscribable.notify

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

Inherited from

AbstractSubscribable.notifySubscription

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

Inherited from

AbstractSubscribable.onSubDestroyed

Defined in

src/sdk/sub/AbstractSubscribable.ts:164

---

pause

▸ pause(): this

Pauses the subscription to the parent subscribable. Once paused, this subscribable will not update its state until it is resumed.

Returns

this

This subscribable, after it has been paused.

Throws

Error if the subscription to the parent subscribable is not alive.

Implementation of

MappedSubscribable.pause

Defined in

src/sdk/sub/MappedSubject.ts:175

---

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

MappedSubscribable.pipe

Inherited from

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

MappedSubscribable.pipe

Inherited from

AbstractSubscribable.pipe

Defined in

src/sdk/sub/AbstractSubscribable.ts:229

---

resume

▸ resume(): this

Resumes the subscription to the parent subscribable. Once resumed, this subscribable will immediately begin to update its state based its parent's state.

Any initialNotify argument passed to this method is ignored. This subscribable is always immediately notified of its parent's state when resumed.

Returns

this

This subscribable, after it has been resumed.

Throws

Error if the subscription to the parent subscribable is not alive.

Implementation of

MappedSubscribable.resume

Defined in

src/sdk/sub/MappedSubject.ts:194

---

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

MappedSubscribable.sub

Inherited from

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

MappedSubscribable.unsub

Inherited from

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

Inherited from

AbstractSubscribable.DEFAULT_EQUALITY_FUNC

Defined in

src/sdk/sub/AbstractSubscribable.ts:18

---

create

▸ create<I>(...inputs): MappedSubject<I, Readonly<I>>

Creates a new mapped subject whose state is a combined tuple of an arbitrary number of input values.

Type parameters

Name	Type
I	extends any[]

Parameters

Name	Type	Description
...inputs	MappedSubscribableInputs<I>	The subscribables which provide the inputs to the new subject.

Returns

MappedSubject<I, Readonly<I>>

A new subject whose state is a combined tuple of the specified input values.

Defined in

src/sdk/sub/MappedSubject.ts:89

▸ create<I, T>(mapFunc, ...inputs): MappedSubject<I, T>

Creates a new mapped subject. Values are compared for equality using the strict equality comparison (===).

Type parameters

Name	Type
I	extends any[]
T	T

Parameters

Name	Type	Description
mapFunc	(inputs: Readonly<I>, previousVal?: T) => T	The function to use to map inputs to the new subject value.
...inputs	MappedSubscribableInputs<I>	The subscribables which provide the inputs to the new subject.

Returns

MappedSubject<I, T>

Defined in

src/sdk/sub/MappedSubject.ts:97

▸ create<I, T>(mapFunc, equalityFunc, ...inputs): MappedSubject<I, T>

Creates a new mapped subject. Values are compared for equality using a custom function.

Type parameters

Name	Type
I	extends any[]
T	T

Parameters

Name	Type	Description
mapFunc	(inputs: Readonly<I>, previousVal?: T) => T	The function to use to map inputs to the new subject value.
equalityFunc	(a: T, b: T) => boolean	The function which the new subject uses to check for equality between values.
...inputs	MappedSubscribableInputs<I>	The subscribables which provide the inputs to the new subject.

Returns

MappedSubject<I, T>

Defined in

src/sdk/sub/MappedSubject.ts:107

▸ create<I, T>(mapFunc, equalityFunc, mutateFunc, initialVal, ...inputs): MappedSubject<I, T>

Creates a new mapped subject with a persistent, cached value which is mutated when it changes. Values are compared for equality using a custom function.

Type parameters

Name	Type
I	extends any[]
T	T

Parameters

Name	Type	Description
mapFunc	(inputs: Readonly<I>, previousVal?: T) => T	The function to use to map inputs to the new subject value.
equalityFunc	(a: T, b: T) => boolean	The function which the new subject uses to check for equality between values.
mutateFunc	(oldVal: T, newVal: T) => void	The function to use to change the value of the new subject.
initialVal	T	The initial value of the new subject.
...inputs	MappedSubscribableInputs<I>	The subscribables which provide the inputs to the new subject.

Returns

MappedSubject<I, T>

Defined in

src/sdk/sub/MappedSubject.ts:121