Interface SubscribableStore<T>

Represents a store accepting registrations (subscribers) and "pushing" notifications on each and every store value change.

interface SubscribableStore<T> {
subscribe(subscriber): Unsubscriber;
}

Type Parameters

T

Hierarchy (view full)

SubscribableStore
- Readable

Index

Methods

Methods

subscribe

subscribe(subscriber): Unsubscriber
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 Unsubscriber
The UnsubscribeFunction or UnsubscribeObject that can be used to unsubscribe (stop state change notifications).
- Defined in index.ts:107

Generated using TypeDoc