Interface Readable<T>

This interface augments the base SubscribableStore interface by requiring the return value of the subscribe method to be both a function and an object with the unsubscribe method.

For interoperability with rxjs, it also implements the [Symbol.observable] method.

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

Type Parameters

Hierarchy (view full)

SubscribableStore<T>
InteropObservable<T>
- Readable
  - ReadableSignal
  - Writable

Implemented by

Store

Index

Methods

[observable] subscribe

Methods

[observable]

[observable](): Readable<T>
Returns Readable<T>
Overrides InteropObservable.[observable]
- Defined in index.ts:129

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).
Overrides SubscribableStore.subscribe
- Defined in index.ts:128

Interface Readable<T>

Type Parameters

T

Hierarchy (view full)

Implemented by

Index

Methods

Methods

[observable]

Returns Readable<T>

subscribe

Parameters

subscriber: Subscriber<T>

Returns UnsubscribeFunction & UnsubscribeObject

Settings

Theme

On This Page