Interface ReadableSignal<T>

This interface augments the base Readable interface by adding the ability to call the store as a function to get its value.

interface ReadableSignal<T> {
    [observable](): Readable<T>;
    get(): T;
    subscribe(subscriber: Subscriber<T>): UnsubscribeFunction & UnsubscribeObject;
    (): T;
}

Type Parameters

T

Hierarchy (view full)

Readable<T>
- ReadableSignal
  - WritableSignal

ReadableSignal(): T
Returns the value of the store.

Returns T
- Defined in types.ts:121

Index

Methods

[observable] get subscribe

Methods

[observable]

[observable](): Readable<T>
Returns Readable<T>
Inherited from Readable.[observable]
- Defined in types.ts:111

get

get(): T
Returns the value of the store.

Returns T
Inherited from Readable.get
- Defined in types.ts:101

subscribe

subscribe(subscriber): UnsubscribeFunction & UnsubscribeObject
A method that makes it possible to register "interest" in store value changes over time. It is called each and every time the store's value changes.

A registered subscriber is notified synchronously with the latest store value.
Parameters
- subscriber: Subscriber<T>
  a subscriber in a form of a SubscriberFunction or a SubscriberObject. Returns a Unsubscriber (function or object with the unsubscribe method) that can be used to unregister and stop receiving notifications of store value changes.
Returns UnsubscribeFunction & UnsubscribeObject
The UnsubscribeFunction or UnsubscribeObject that can be used to unsubscribe (stop state change notifications).
Inherited from Readable.subscribe
- Defined in types.ts:110