Class MutableReactiveValue<T>`Abstract`

A ReactiveValue is a value that

updates periodically,
can fire listeners when it updates,
and can be chanined together with other ReactiveValues.

A ReactiveValue is a read-only view. See MutableReactiveValue for a read-write view.

Static methods in the ReactiveValue and MutableReactiveValue classes are constructors (e.g. fromImmutable).

Avoid extending this class from an external library, as that may not be stable.

Type Parameters

Hierarchy (View Summary)

ReactiveValue<T>
- MutableReactiveValue

Index

Constructors

constructor

Methods

get onUpdate onUpdateAndNow set waitForNextUpdate fromCallback fromImmutable fromInitialValue fromProperty map union

Constructors

constructor

new MutableReactiveValue<T>(): MutableReactiveValue<T>
Type Parameters
- T
Returns MutableReactiveValue<T>
Inherited from ReactiveValue.constructor

Methods

`Abstract`get

get(): T
Returns a reference to the current value of this ReactiveValue.

The result of this should not be modified (use setValue instead).

Returns T
Inherited from ReactiveValue.get
- Defined in util/ReactiveValue.ts:40

`Abstract`onUpdate

onUpdate(listener: UpdateCallback<T>): ListenerResult
Registers a listener that is notified when the value of this changes.
Parameters
- listener: UpdateCallback<T>
Returns ListenerResult
Inherited from ReactiveValue.onUpdate
- Defined in util/ReactiveValue.ts:45

`Abstract`onUpdateAndNow

onUpdateAndNow(callback: UpdateCallback<T>): ListenerResult
Calls callback immediately, then registers callback as an onUpdateListener.
Parameters
- callback: UpdateCallback<T>
Returns ListenerResult
See
onUpdate.
Inherited from ReactiveValue.onUpdateAndNow
- Defined in util/ReactiveValue.ts:52

`Abstract`set

set(newValue: T): void
Changes the value of this and, if different, fires all update listeners.
Parameters
- newValue: T
Returns void
See
onUpdate
- Defined in util/ReactiveValue.ts:175

waitForNextUpdate

waitForNextUpdate(): Promise<T>
Returns a promise that resolves when this value is next changed.

Returns Promise<T>
Inherited from ReactiveValue.waitForNextUpdate
- Defined in util/ReactiveValue.ts:55

`Static`fromCallback

fromCallback<T>(
callback: () => T,
sourceValues: ReactiveValue<any>[],
): ReactiveValue<T>
Creates a ReactiveValue whose values come from callback.

callback is called whenever any of sourceValues are updated and initially to set the initial value of the result.
Type Parameters
- T
Parameters
- callback: () => T
- sourceValues: ReactiveValue<any>[]
Returns ReactiveValue<T>
Inherited from ReactiveValue.fromCallback
- Defined in util/ReactiveValue.ts:89

`Static`fromImmutable

fromImmutable<T>(value: T): ReactiveValue<T>
Returns a ReactiveValue that is known will never change.
Type Parameters
- T
Parameters
- value: T
Returns ReactiveValue<T>
Inherited from ReactiveValue.fromImmutable
- Defined in util/ReactiveValue.ts:70

`Static`fromInitialValue

fromInitialValue<T>(initialValue: T): MutableReactiveValue<T>
Creates a ReactiveValue with an initial value, initialValue.
Type Parameters
- T
Parameters
- initialValue: T
Returns MutableReactiveValue<T>
Inherited from ReactiveValue.fromInitialValue
- Defined in util/ReactiveValue.ts:65

`Static`fromProperty

fromProperty<SourceType extends object, Name extends string | number | symbol>(
sourceValue: MutableReactiveValue<SourceType>,
propertyName: Name,
): MutableReactiveValue<SourceType[Name]>
Type Parameters
- SourceType extends object
- Name extends string | number | symbol
Parameters
- sourceValue: MutableReactiveValue<SourceType>
- propertyName: Name
Returns MutableReactiveValue<SourceType[Name]>
- Defined in util/ReactiveValue.ts:177

`Static`map

map<A, B>(
    source: ReactiveValue<A>,
    map: (a: A) => B,
    inverseMap?: undefined,
): ReactiveValue<B>
Returns a reactive value derived from a single source.

If inverseMap is undefined, the result is a read-only view.
Type Parameters
- A
- B
Parameters
- source: ReactiveValue<A>
- map: (a: A) => B
- OptionalinverseMap: undefined
Returns ReactiveValue<B>
Inherited from ReactiveValue.map
- Defined in util/ReactiveValue.ts:119
map<A, B>(
    source: ReactiveValue<A>,
    map: (a: A) => B,
    inverseMap: (b: B) => A,
): MutableReactiveValue<B>
Returns a reactive value derived from a single source.
Type Parameters
- A
- B
Parameters
- source: ReactiveValue<A>
- map: (a: A) => B
- inverseMap: (b: B) => A
Returns MutableReactiveValue<B>
Inherited from ReactiveValue.map
- Defined in util/ReactiveValue.ts:128

`Static`union

union<Values extends unknown[]>(
values: ReactiveValuesOf<Values>,
): ReactiveValue<Values>
Type Parameters
- Values extends unknown[]
Parameters
- values: ReactiveValuesOf<Values>
Returns ReactiveValue<Values>
Inherited from ReactiveValue.union
- Defined in util/ReactiveValue.ts:160

Class MutableReactiveValue<T>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Returns MutableReactiveValue<T>

Methods

Abstractget

Returns T

AbstractonUpdate

Parameters

Returns ListenerResult

AbstractonUpdateAndNow

Parameters

Returns ListenerResult

See

Abstractset

Parameters

Returns void

See

waitForNextUpdate

Returns Promise<T>

StaticfromCallback

Type Parameters

Parameters

Returns ReactiveValue<T>

StaticfromImmutable

Type Parameters

Parameters

Returns ReactiveValue<T>

StaticfromInitialValue

Type Parameters

Parameters

Returns MutableReactiveValue<T>

StaticfromProperty

Type Parameters

Parameters

Returns MutableReactiveValue<SourceType[Name]>

Staticmap

Type Parameters

Parameters

Returns ReactiveValue<B>

Type Parameters

Parameters

Returns MutableReactiveValue<B>

Staticunion

Type Parameters

Parameters

Returns ReactiveValue<Values>

Settings

On This Page

Class MutableReactiveValue<T>`Abstract`

`Abstract`get

`Abstract`onUpdate

`Abstract`onUpdateAndNow

`Abstract`set

`Static`fromCallback

`Static`fromImmutable

`Static`fromInitialValue

`Static`fromProperty

`Static`map

`Static`union