Class ObservableNumber`Beta`

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

Index

Constructors

Methods

getData setData subscribe unsubscribe

Constructors

constructor

new ObservableNumber(
data: number,
options?: ObservableOptions,
): ObservableNumber
Beta
Parameters
- data: number
  The initial numeric value for this observable.
- Optionaloptions: ObservableOptions
  Optional configuration for the observable, such as whether the value can be written by the client.
Returns ObservableNumber
Remarks
Creates a new ObservableNumber with the provided initial numeric 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:1343

Methods

getData

getData(): number
Beta
Returns number
Remarks
Returns the current numeric 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:1353

setData

setData(data: number): void
Beta
Parameters
- data: number
  The new numeric value to set.
Returns void
Remarks
Updates the numeric 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:1367

subscribe(callback: (arg0: number) => void): (arg0: number) => void
Beta
Parameters
- callback: (arg0: number) => void
  A function that receives the new numeric value each time the observable changes.
Returns (arg0: number) => 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:1382

unsubscribe

unsubscribe(callback: (arg0: number) => void): boolean
Beta
Parameters
- callback: (arg0: number) => 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:1396