Interface ExternalStore<Value>

The observable external store.

interface ExternalStore<Value = any> {
    delete?(): void;
    get(): Value | null;
    set?(value: Value): void;
    subscribe(
        listener: (value: void | Value | null | undefined) => void,
    ): () => void;
}

Type Parameters

Value = any
The value held by the external store.

Hierarchy (View Summary)

Observable<Value | null | undefined | void>
- ExternalStore

Index

Methods

delete? get set? subscribe

Methods

`Optional`delete

delete?(): void
Deletes a value from the store.

Returns void

get

get(): Value | null
Returns the current stored value, or null if there's no value.

Returns Value | null

`Optional`set

set?(value: Value): void
Sets a new value to the store.
Parameters
- value: Value
  A value to set.
Returns void

subscribe(
listener: (value: void | Value | null | undefined) => void,
): () => void
Subscribes the listener to changes of the observed value.
Parameters
- listener: (value: void | Value | null | undefined) => void
  The listener to subscribe.
Returns () => void
Inherited from Observable.subscribe