Interface ReactiveStore<State>

Interface for a store that can be subscribed for changes.

interface ReactiveStore {
    started: boolean;
    close(options?): MaybePromise<void>;
    getState(): State;
    iterator(options?): AsyncIterableIterator<State>;
    start(options?): MaybePromise<void>;
    subscribe(handler, options?): MaybePromise<Unsubscribe>;
}

Type Parameters

  • State = unknown

Hierarchy

Implemented by

Properties

started

Methods

close getState iterator start subscribe

Properties

Readonly started

started: boolean

Returns if this has started.

Methods

close

  • close(options?): MaybePromise<void>

  • Closes this object and releases any system resource associated with it.

    Parameters

    Returns MaybePromise<void>

getState

  • getState(): State

  • Returns the current state.

    Returns State

iterator

start

subscribe

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc