Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StrictStore<State, M, A, G>

Type parameters

  • State

  • M: MutationTree<State>

  • A: ActionTree<State, State>

  • G: GetterTree<State, State>

Hierarchy

  • Store<State>
    • StrictStore

Index

Constructors

Properties

Methods

Constructors

constructor

  • new StrictStore(options: StoreOptions<State>): StrictStore

  • Parameters

    • options: StoreOptions<State>

    Returns StrictStore

Properties

commit

commit: function

Type declaration

    • <T>(type: T, payload?: PayloadType<M[T]>, options?: CommitOptions): void
    • (payloadWithType: PayloadWithType<M>, options?: CommitOptions): void

    • Type parameters

      • T: keyof M

      Parameters

      • type: T
      • Optional payload: PayloadType<M[T]>
      • Optional options: CommitOptions

      Returns void

    • Parameters

      Returns void

dispatch

dispatch: function

Type declaration

    • <T>(type: T, payload?: PayloadType<A[T]>, options?: DispatchOptions): Promise<any>
    • (payloadWithType: PayloadWithType<A>, options?: DispatchOptions): Promise<any>

    • Type parameters

      • T: keyof A

      Parameters

      • type: T
      • Optional payload: PayloadType<A[T]>
      • Optional options: DispatchOptions

      Returns Promise<any>

    • Parameters

      Returns Promise<any>

getters

getters: object

Type declaration

state

state: State

Methods

hotUpdate

  • hotUpdate(options: object): void

  • Parameters

    • options: object
      • Optional actions?: ActionTree<State, State>
      • Optional getters?: GetterTree<State, State>
      • Optional modules?: ModuleTree<State>
      • Optional mutations?: MutationTree<State>

    Returns void

registerModule

  • registerModule<T>(path: string, module: Module<T, State>, options?: ModuleOptions): void
  • registerModule<T>(path: string[], module: Module<T, State>, options?: ModuleOptions): void

  • Type parameters

    • T

    Parameters

    • path: string
    • module: Module<T, State>
    • Optional options: ModuleOptions

    Returns void

  • Type parameters

    • T

    Parameters

    • path: string[]
    • module: Module<T, State>
    • Optional options: ModuleOptions

    Returns void

replaceState

  • replaceState(state: State): void

  • Parameters

    • state: State

    Returns void

subscribe

  • subscribe<P>(fn: function): function

  • Type parameters

    • P: MutationPayload

    Parameters

    • fn: function
        • (mutation: P, state: State): any

        • Parameters

          • mutation: P
          • state: State

          Returns any

    Returns function

      • (): void

      • Returns void

unregisterModule

  • unregisterModule(path: string): void
  • unregisterModule(path: string[]): void

  • Parameters

    • path: string

    Returns void

  • Parameters

    • path: string[]

    Returns void

watch

  • watch<T>(getter: function, cb: function, options?: WatchOptions): function

  • Type parameters

    • T

    Parameters

    • getter: function
        • (state: State): T

        • Parameters

          • state: State

          Returns T

    • cb: function
        • (value: T, oldValue: T): void

        • Parameters

          • value: T
          • oldValue: T

          Returns void

    • Optional options: WatchOptions

    Returns function

      • (): void

      • Returns void

Generated using TypeDoc