Class: ReadonlyPerformanceVariable<T>

Defined in: wtlinesdk/performance/PerformanceVariable.ts:6

A performance variable

Type Parameters

Type Parameter
T

Implements

• Subscribable<T>

Constructors

Constructor

protected new ReadonlyPerformanceVariable<T>(input): ReadonlyPerformanceVariable<T>

Defined in: wtlinesdk/performance/PerformanceVariable.ts:16

Ctor

Parameters

Parameter	Type	Description
input	Subscribable<T>	a subject

Returns

ReadonlyPerformanceVariable<T>

Properties

data

data: DataInterface<T>

Defined in: wtlinesdk/performance/PerformanceVariable.ts:9

---

input

input: Subscribable<T>

Defined in: wtlinesdk/performance/PerformanceVariable.ts:17

a subject

---

isSubscribable

readonly isSubscribable: true = true

Defined in: wtlinesdk/performance/PerformanceVariable.ts:7

Flags this object as a Subscribable.

Implementation of

Subscribable.isSubscribable

Methods

get()

get(): T

Defined in: wtlinesdk/performance/PerformanceVariable.ts:23

Gets this item's state.

Returns

T

This item's state.

Implementation of

Subscribable.get

---

map()

Call Signature

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

Defined in: wtlinesdk/performance/PerformanceVariable.ts:39

Maps this subscribable 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

MappedSubscribable<M>

The mapped subscribable.

Implementation of

Subscribable.map

Call Signature

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

Defined in: wtlinesdk/performance/PerformanceVariable.ts:48

Maps this subscribable 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

MappedSubscribable<M>

The mapped subscribable.

Implementation of

Subscribable.map

---

pipe()

Call Signature

pipe(to, paused?): Subscription

Defined in: wtlinesdk/performance/PerformanceVariable.ts:75

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

Subscribable.pipe

Call Signature

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

Defined in: wtlinesdk/performance/PerformanceVariable.ts:85

Subscribes to and accepts mapped inputs from another subscribable. Whenever an update of the other 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 this 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

Subscribable.pipe

---

sub()

sub(fn, initialNotify, paused): Subscription

Defined in: wtlinesdk/performance/PerformanceVariable.ts:28

Subscribes to changes in this subscribable's state.

Parameters

Parameter	Type	Default value	Description
fn	(value) => 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