Observable<T>
Defined in: src/lib/observable/observable.ts:125
Base Observable class for local-only reactivity.
This class provides the foundation for all observable types:
- Value storage and retrieval
- Subscription management
- Change notification
- Inter-observable piping
Type Parameters
| Type Parameter | Description |
|---|---|
T | The type of value stored in the observable |
Implements
Constructors
Constructor
new Observable\<T\>(options: ObservableOptions\<T\>): Observable\<T\>;Defined in: src/lib/observable/observable.ts:161
Create a new Observable.
Parameters
| Parameter | Type | Description |
|---|---|---|
options | ObservableOptions<T> | Configuration options |
Returns
Observable<T>
Properties
| Property | Modifier | Type | Default value | Description | Defined in |
|---|---|---|---|---|---|
_previousValue | protected | T | undefined | Previous value (for change detection). | src/lib/observable/observable.ts:133 |
_value | protected | T | undefined | Current value. | src/lib/observable/observable.ts:130 |
debounceMs | readonly | number | undefined | Debounce delay in milliseconds. | src/lib/observable/observable.ts:148 |
debounceTimer | protected | CitizenTimer | null | null | Debounce timer handle. | src/lib/observable/observable.ts:145 |
equals | readonly | (a: T, b: T) => boolean | undefined | Equality function for change detection. | src/lib/observable/observable.ts:142 |
id | readonly | string | undefined | Unique identifier for this observable. | src/lib/observable/observable.ts:127 |
isDebouncing | protected | boolean | false | Whether we're currently in a debounce period. | src/lib/observable/observable.ts:154 |
pendingValue | protected | T | undefined | undefined | Pending value during debounce. | src/lib/observable/observable.ts:151 |
returnedSubscriptions | readonly | Set<Subscription> | undefined | Returned subscription objects (for disposal). | src/lib/observable/observable.ts:139 |
subscriptions | readonly | Set<SubscriptionInfo<T>> | undefined | Active subscriptions (for internal tracking). | src/lib/observable/observable.ts:136 |
Accessors
value
Get Signature
get value(): T;Defined in: src/lib/observable/observable.ts:172
Get the current value.
Returns
T
The current value.
Implementation of
Methods
dispose()
dispose(): void;Defined in: src/lib/observable/observable.ts:300
Dispose of the observable and clean up resources.
Returns
void
pipe()
pipe\<U\>(source: ReadonlyObservable\<U\>, transform?: (value: U) => T): Subscription;Defined in: src/lib/observable/observable.ts:245
Subscribe to another observable, updating this one when it changes. Creates a one-way binding from source to this observable.
Type Parameters
| Type Parameter |
|---|
U |
Parameters
| Parameter | Type | Description |
|---|---|---|
source | ReadonlyObservable<U> | The source observable to subscribe to |
transform? | (value: U) => T | Optional transform function |
Returns
Subscription that can be disposed to unsubscribe
Implementation of
set()
set(newValue: T): void;Defined in: src/lib/observable/observable.ts:182
Set a new value. Notifies subscribers if value changed according to equality function.
Parameters
| Parameter | Type | Description |
|---|---|---|
newValue | T | The new value |
Returns
void
Implementation of
subscribe()
subscribe(callback: SubscriptionCallback\<T\>): Subscription;Defined in: src/lib/observable/observable.ts:213
Subscribe to value changes.
Parameters
| Parameter | Type | Description |
|---|---|---|
callback | SubscriptionCallback<T> | Function called when value changes |
Returns
Subscription that can be disposed to unsubscribe
Implementation of
update()
update(updater: (current: T) => T): void;Defined in: src/lib/observable/observable.ts:203
Update the value using a function.
Parameters
| Parameter | Type | Description |
|---|---|---|
updater | (current: T) => T | Function that receives current value and returns new value |
Returns
void