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 full)

ReactiveValue<T>
- MutableReactiveValue

Index

Constructors

constructor

Methods

get onUpdate onUpdateAndNow set fromCallback fromImmutable fromInitialValue fromProperty map

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:37

`Abstract` onUpdate

onUpdate(listener): 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:42

`Abstract` onUpdateAndNow

onUpdateAndNow(callback): 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:49

`Abstract` set

set(newValue): 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:155

`Static` fromCallback

fromCallback<T>(callback, sourceValues): 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)
  - - (): T
    - Returns T
- sourceValues: ReactiveValue<any>[]
Returns ReactiveValue<T>
Inherited from ReactiveValue.fromCallback
- Defined in util/ReactiveValue.ts:78

`Static` fromImmutable

fromImmutable<T>(value): 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:59

`Static` fromInitialValue

fromInitialValue<T>(initialValue): 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:52

`Static` fromProperty

fromProperty<SourceType, Name>(sourceValue, propertyName): 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:157

`Static` map

map<A, B>(source, map, inverseMap?): 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) => B)
  - - (a): B
    - Parameters
      a: A
      Returns B
- Optional inverseMap: undefined
Returns ReactiveValue<B>
Inherited from ReactiveValue.map
- Defined in util/ReactiveValue.ts:105
map<A, B>(source, map, inverseMap): MutableReactiveValue<B>
Returns a reactive value derived from a single source.
Type Parameters
- A
- B
Parameters
- source: ReactiveValue<A>
- map: ((a) => B)
  - - (a): B
    - Parameters
      a: A
      Returns B
- inverseMap: ((b) => A)
  - - (b): A
    - Parameters
      b: B
      Returns A
Returns MutableReactiveValue<B>
Inherited from ReactiveValue.map
- Defined in util/ReactiveValue.ts:115

Class MutableReactiveValue<T>Abstract

Type Parameters

T

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Type Parameters

T

Returns MutableReactiveValue<T>

Methods

Abstract get

Returns T

Abstract onUpdate

Parameters

listener: UpdateCallback<T>

Returns ListenerResult

Abstract onUpdateAndNow

Parameters

callback: UpdateCallback<T>

Returns ListenerResult

See

Abstract set

Parameters

newValue: T

Returns void

See

Static fromCallback

Type Parameters

T

Parameters

callback: (() => T)

Returns T

sourceValues: ReactiveValue<any>[]

Returns ReactiveValue<T>

Static fromImmutable

Type Parameters

T

Parameters

value: T

Returns ReactiveValue<T>

Static fromInitialValue

Type Parameters

T

Parameters

initialValue: T

Returns MutableReactiveValue<T>

Static fromProperty

Type Parameters

SourceType extends object

Name extends string | number | symbol

Parameters

sourceValue: MutableReactiveValue<SourceType>

propertyName: Name

Returns MutableReactiveValue<SourceType[Name]>

Static map

Type Parameters

A

B

Parameters

source: ReactiveValue<A>

map: ((a) => B)

Parameters

a: A

Returns B

Optional inverseMap: undefined

Returns ReactiveValue<B>

Type Parameters

A

B

Parameters

source: ReactiveValue<A>

map: ((a) => B)

Parameters

a: A

Returns B

inverseMap: ((b) => A)

Parameters

Class MutableReactiveValue<T>`Abstract`

`Abstract` get

`Abstract` onUpdate

`Abstract` onUpdateAndNow

`Abstract` set

`Static` fromCallback

`Static` fromImmutable

`Static` fromInitialValue

`Static` fromProperty

`Static` map

`Optional` inverseMap: undefined