Class Observable<T>`Beta`

A class that represents data that can be Observed. Extensively used for UI.

Type Parameters

T extends string | number | boolean | UIRawMessage

Index

Constructors

Methods

getData setData subscribe unsubscribe create

Constructors

constructor

new Observable<T extends string | number | boolean | UIRawMessage>(): Observable<
T,
>
Type Parameters
- T extends string | number | boolean | UIRawMessage
Returns Observable<T>

Methods

getData

getData(): T
Returns T
Remarks
Gets the data from the Observable.

World Ready
This function can't be called in early-execution mode.

setData

setData(data: T): void
Parameters
- data: T
Returns void
Remarks
Sets the data on this Observable and notifies the subscribers.

World Ready
This function can't be called in early-execution mode.

subscribe(listener: (newValue: T) => void): (newValue: T) => void
Parameters
- listener: (newValue: T) => void
Returns (newValue: T) => void
Remarks
Subscribes a callback to any changes that occur to the Observable. The return value can be passed into the unsubscribe function to stop listening to changes.

World Ready
This function can't be called in early-execution mode.

unsubscribe

unsubscribe(listener: (newValue: T) => void): void
Parameters
- listener: (newValue: T) => void
Returns void
Remarks
Unsubscribe a callback from any changes that occur to the Observable. This takes the return value from the subscribe function.

World Ready
This function can't be called in early-execution mode.

`Static`create

create<T extends string | number | boolean | UIRawMessage>(
data: T,
options?: ObservableOptions,
): Observable<T>
Type Parameters
- T extends string | number | boolean | UIRawMessage
Parameters
- data: T
- Optionaloptions: ObservableOptions
Returns Observable<T>
Remarks
Creates an Observable, use this instead of a constructor.

World Ready
This function can't be called in early-execution mode.