Interface ObservableValue<T>

interface ObservableValue<out T> {
    changeId: number;
    value: T;
    getValue(): T;
    map<U>(transform: (value: T) => U): ObservableValue<U>;
    onData(callback: DataChangedCallback<T>): Unsubscribe;
    pick<K extends string | number | symbol>(
        prop: K,
    ): ObservableValue<Picked<T, K>>;
    pick(prop: PropertyKey): ObservableValue<unknown>;
}

Type Parameters

out T

Hierarchy (View Summary)

ObservableValue
- MutableValue
- ManifestController

Index

Properties

Methods

getValue map onData pick

Properties

`Readonly`changeId

changeId: number

A monotonically increasing id that increments before each change notification.

`Readonly`value

value: T

The current value.

Methods

getValue

getValue(): T
Gets the current value.

Returns T
- Defined in observableValue.ts:35

map

map<U>(transform: (value: T) => U): ObservableValue<U>
Creates a data provider transforming this data.
Type Parameters
- U
Parameters
- transform: (value: T) => U
Returns ObservableValue<U>
- Defined in observableValue.ts:19

onData

onData(callback: DataChangedCallback<T>): Unsubscribe
Invokes a callback immediately and when data has changed.
Parameters
- callback: DataChangedCallback<T>
Returns Unsubscribe
- Defined in observableValue.ts:14

pick

pick<K extends string | number | symbol>(prop: K): ObservableValue<Picked<T, K>>
Returns a data provider for a property of T.
Type Parameters
- K extends string | number | symbol
Parameters
- prop: K
Returns ObservableValue<Picked<T, K>>
- Defined in observableValue.ts:24
pick(prop: PropertyKey): ObservableValue<unknown>
Parameters
- prop: PropertyKey
Returns ObservableValue<unknown>
- Defined in observableValue.ts:25