Class ObservableBoolean`Beta`

An observable that holds a boolean value. Listeners are notified whenever the value changes.

Index

Constructors

Methods

getData setData subscribe unsubscribe

Constructors

constructor

new ObservableBoolean(
data: boolean,
options?: ObservableOptions,
): ObservableBoolean
Beta
Parameters
- data: boolean
  The initial boolean value for this observable.
- Optionaloptions: ObservableOptions
  Optional configuration for the observable, such as whether the value can be written by the client.
Returns ObservableBoolean
Remarks
Creates a new ObservableBoolean with the provided initial boolean value.

Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Privilege
early-execution-allowed - This function can be called in early-execution mode.
- Defined in tmp/package/index.d.ts:1267

Methods

getData

getData(): boolean
Beta
Returns boolean
Remarks
Returns the current boolean value held by this observable.

Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Privilege
early-execution-allowed - This function can be called in early-execution mode.
- Defined in tmp/package/index.d.ts:1277

setData

setData(data: boolean): void
Beta
Parameters
- data: boolean
  The new boolean value to set.
Returns void
Remarks
Updates the boolean value held by this observable. If the new value differs from the current value, all subscribed listeners are notified with the new value.

Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Privilege
early-execution-allowed - This function can be called in early-execution mode.
- Defined in tmp/package/index.d.ts:1291

subscribe(callback: (arg0: boolean) => void): (arg0: boolean) => void
Beta
Parameters
- callback: (arg0: boolean) => void
  A function that receives the new boolean value each time the observable changes.
Returns (arg0: boolean) => void
Remarks
Registers a callback to be invoked whenever the observable's value changes. Returns the callback, which can be passed to unsubscribe to remove the listener.

Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Privilege
early-execution-allowed - This function can be called in early-execution mode.
- Defined in tmp/package/index.d.ts:1306

unsubscribe

unsubscribe(callback: (arg0: boolean) => void): boolean
Beta
Parameters
- callback: (arg0: boolean) => void
  The callback handle previously returned by subscribe.
Returns boolean
Remarks
Removes a previously registered listener from this observable. Returns true if the listener was found and removed, false if it was not found.

Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Privilege
early-execution-allowed - This function can be called in early-execution mode.
- Defined in tmp/package/index.d.ts:1320