IWatchedValue<T>
Interface
Types Module: Broker
Type parameters
| Name |
|---|
T |
Methods
setValue
Set value for the watched value
Signature
setValue(value: T, forceUpdate?: boolean) => void
Parameters
| Name | Type | Description |
|---|---|---|
| value | T | value to set |
| forceUpdate? | boolean | force an update |
Returns
void
Overrides
subscribe
Subscribe to watched value changes
Signature
subscribe(callback: WatchedValueCallback<T>, options?: WatchedValueSubscribeOptions) => void
Parameters
| Name | Type | Description |
|---|---|---|
| callback | WatchedValueCallback<T> | callback to be evoked when change occurs |
| options? | WatchedValueSubscribeOptions | watch subscriber options |
Returns
void
Overrides
unsubscribe
Unsubscribe to watched value changes
Signature
unsubscribe(callback?: WatchedValueCallback<T>) => void
Parameters
| Name | Type | Description |
|---|---|---|
| callback? | WatchedValueCallback<T> | callback to remove |
Returns
void
Overrides
value
Value
Signature
value() => T
Returns
T
when
A simplified version of subscription, with promise-like interface, generally for using with boolean-valued watched values
Signature
when(callback: WatchedValueCallback<T>) => void
Parameters
| Name | Type | Description |
|---|---|---|
| callback | WatchedValueCallback<T> | a function to be called when the value became true. once and callWithLast are implicitly set to true. |
Returns
void