Interface SyncState<StateType>

interface SyncState<StateType> {
    [INITIAL_STATE]: StateType;
    [STATE]: StateType;
    _addEventListener: ((type, listener, options) => void);
    listeners: EventListenerRegistry;
    options: SyncStateOptions;
    removeAllEventListeners: ((type) => void);
    removeEventListenerById: ((type, id) => void);
    reset: (() => this);
    get initial(): StateType;
    get state(): StateType;
    get stateObj(): {
        state: StateType;
    };
    del(path, update?): any;
    dispatch<Payload>(type, payload?): this;
    extend(prop, method): void;
    get<RTN>(path, defaultValue): any;
    set<VAL>(path, value, update?, forceMerge?): this;
    [key: string]: any;
}

Type Parameters

  • StateType extends object

Implemented by

Indexable

[key: string]: any

Properties

[INITIAL_STATE] [STATE] _addEventListener listeners options removeAllEventListeners removeEventListenerById reset

Accessors

initial state stateObj

Methods

del dispatch extend get set

Properties

[INITIAL_STATE]

[INITIAL_STATE]: StateType

[STATE]

[STATE]: StateType

_addEventListener

_addEventListener: ((type, listener, options) => void)

Type declaration

    • (type, listener, options): void

    • Parameters

      • type: string
      • listener: ((e) => void)
          • (e): void

          • Parameters

            • e: Event

            Returns void

      • options: any

      Returns void

listeners

listeners: EventListenerRegistry

options

options: SyncStateOptions

removeAllEventListeners

removeAllEventListeners: ((type) => void)

Type declaration

    • (type): void

    • Parameters

      • type: string

      Returns void

removeEventListenerById

removeEventListenerById: ((type, id) => void)

Type declaration

    • (type, id): void

    • Parameters

      • type: string
      • id: string

      Returns void

reset

reset: (() => this)

Type declaration

    • (): this

    • Returns this

Accessors

initial

state

stateObj

Methods

del

dispatch

extend

get

set

Settings

Member Visibility

Theme

On This Page

[INITIAL_STATE][STATE]_addEventListenerlistenersoptionsremoveAllEventListenersremoveEventListenerByIdresetinitialstatestateObjdeldispatchextendgetset