Class: ComputedSubject<I, T>

Defined in: src/sdk/sub/ComputedSubject.ts:14

A class for subjects that return a computed value. ComputedSubject

Type Parameters

Type Parameter	Description
I	The type of the input value.
T	The type of the computed output value.

Implements

• MutableSubscribable<T, I>

Properties

isMutableSubscribable

readonly isMutableSubscribable: true = true

Defined in: src/sdk/sub/ComputedSubject.ts:16

Flags this object as a MutableSubscribable.

Implementation of

MutableSubscribable.isMutableSubscribable

---

isSubscribable

readonly isSubscribable: true = true

Defined in: src/sdk/sub/ComputedSubject.ts:15

Flags this object as a Subscribable.

Implementation of

MutableSubscribable.isSubscribable

Methods

get()

get(): T

Defined in: src/sdk/sub/ComputedSubject.ts:64

Gets the computed value of the Subject.

Returns

T

The computed value.

Implementation of

MutableSubscribable.get

---

getRaw()

getRaw(): I

Defined in: src/sdk/sub/ComputedSubject.ts:72

Gets the raw value of the Subject.

Returns

I

The raw value.

---

map()

Call Signature

map<M>(fn, equalityFunc?): MappedSubject<[T], M>

Defined in: src/sdk/sub/ComputedSubject.ts:155

Maps this subject to a new subscribable.

Type Parameters

Type Parameter
M

Parameters

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

Returns

MappedSubject<[T], M>

The mapped subscribable.

Implementation of

MutableSubscribable.map

Call Signature

map<M>(fn, equalityFunc, mutateFunc, initialVal): MappedSubject<[T], M>

Defined in: src/sdk/sub/ComputedSubject.ts:164

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

Type Parameters

Type Parameter
M

Parameters

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

Returns

MappedSubject<[T], M>

The mapped subscribable.

Implementation of

MutableSubscribable.map

---

pipe()

Call Signature

pipe(to, paused?): Subscription

Defined in: src/sdk/sub/ComputedSubject.ts:192

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

Parameter	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

MutableSubscribable.pipe

Call Signature

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

Defined in: src/sdk/sub/ComputedSubject.ts:202

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

Type Parameter
M

Parameters

Parameter	Type	Description
to	MutableSubscribable<any, M>	The mutable subscribable to which to pipe this subscribable's mapped state.
map	(fromVal, toVal) => 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

MutableSubscribable.pipe

---

set()

set(value): void

Defined in: src/sdk/sub/ComputedSubject.ts:51

Sets the new value and notifies the subscribers when value changed.

Parameters

Parameter	Type	Description
value	I	The new value.

Returns

void

Implementation of

MutableSubscribable.set

---

sub()

sub(handler, initialNotify, paused): Subscription

Defined in: src/sdk/sub/ComputedSubject.ts:77

Subscribes to changes in this subscribable's state.

Parameters

Parameter	Type	Default value	Description
handler	(v, rv) => 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

MutableSubscribable.sub

---

unsub()

unsub(handler): void

Defined in: src/sdk/sub/ComputedSubject.ts:92

Unsubscribes a callback function from this subscribable.

Parameters

Parameter	Type	Description
handler	(v, rv) => 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

MutableSubscribable.unsub

---

create()

static create<IT, CT>(v, fn): ComputedSubject<IT, CT>

Defined in: src/sdk/sub/ComputedSubject.ts:43

Creates and returns a new ComputedSubject.

Type Parameters

Type Parameter
IT
CT

Parameters

Parameter	Type	Description
v	IT	The initial value of the Subject.
fn	(v) => CT	A function which transforms raw values to computed values.

Returns

ComputedSubject<IT, CT>

A ComputedSubject instance.