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 getFilteredText setData subscribe toJSON unsubscribe create

Constructors

constructor

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

Methods

getData

getData(): T
Beta
Returns T
Remarks
Gets the data from the Observable.
- Defined in tmp/package/index.d.ts:930

getFilteredText

getFilteredText(
this: Observable<T & string>,
player: Player,
): Promise<string | TextFilteringError[]>
Beta
Parameters
- this: Observable<T & string>
- player: Player
Returns Promise<string | TextFilteringError[]>
Remarks
Gets filtered data from the Observable (only available for strings). In case of failure, it will return an array of TextFilteringError that can provide more context about the filtering process. For testing purposes, the options are available under "Creator -> Text Filtering" settings menu. This delay is only applied to the getFilteredText function and can be used to simulate network latency when testing.
- Defined in tmp/package/index.d.ts:942

setData

setData(data: T): void
Beta
Parameters
- data: T
Returns void
Remarks
Sets the data on this Observable and notifies the subscribers.
- Defined in tmp/package/index.d.ts:952

subscribe(listener: (newValue: T) => void): (newValue: T) => void
Beta
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.
- Defined in tmp/package/index.d.ts:960

toJSON

toJSON(): unknown
Beta
Returns unknown
- Defined in tmp/package/index.d.ts:961

unsubscribe

unsubscribe(listener: (newValue: T) => void): void
Beta
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.
- Defined in tmp/package/index.d.ts:969

`Static`create

create<T extends string | number | boolean | UIRawMessage>(
data: T,
options?: ObservableOptions,
): Observable<T>
Beta
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.
- Defined in tmp/package/index.d.ts:975