Vuex.Store 实例方法

commit

  • commit(type: string, payload?: any, options?: Object)

  • commit(mutation: Object, options?: Object)

提交 mutation。options 里可以有 root: true，它允许在命名空间模块里提交根的 mutation。详细介绍

dispatch

  • dispatch(type: string, payload?: any, options?: Object)

  • dispatch(action: Object, options?: Object)

分发 action。options 里可以有 root: true，它允许在命名空间模块里分发根的 action。返回一个解析所有被触发的 action 处理器的 Promise。详细介绍

replaceState

  • replaceState(state: Object) 替换 store 的根状态，仅用状态合并或时光旅行调试。

watch

  • watch(fn: Function, callback: Function, options?: Object): Function 响应式地侦听 fn 的返回值，当值改变时调用回调函数。fn 接收 store 的 state 作为第一个参数，其 getter 作为第二个参数。最后接收一个可选的对象参数表示 Vue 的 vm.$watch 方法的参数。

要停止侦听，调用此方法返回的函数即可停止侦听。

subscribe

  • subscribe(handler: Function): Function

订阅 store 的 mutation。handler 会在每个 mutation 完成后调用，接收 mutation 和经过 mutation 后的状态作为参数：

  1. store.subscribe((mutation, state) => {
  2.   console.log(mutation.type)
  3.   console.log(mutation.payload)
  4. })

要停止订阅，调用此方法返回的函数即可停止订阅。

通常用于插件。详细介绍

subscribeAction

  • subscribeAction(handler: Function): Function

2.5.0 新增

订阅 store 的 action。handler 会在每个 action 分发的时候调用并接收 action 描述和当前的 store 的 state 这两个参数：

  1. store.subscribeAction((action, state) => {
  2.   console.log(action.type)
  3.   console.log(action.payload)
  4. })

要停止订阅，调用此方法返回的函数即可停止订阅。

3.1.0 新增

从 3.1.0 起，subscribeAction 也可以指定订阅处理函数的被调用时机应该在一个 action 分发之前还是之后 (默认行为是之前)：

  1. store.subscribeAction({
  2.   before: (action, state) => {
  3.     console.log(`before action ${action.type}`)
  4.   },
  5.   after: (action, state) => {
  6.     console.log(`after action ${action.type}`)
  7.   }
  8. })

该功能常用于插件。详细介绍

registerModule

  • registerModule(path: string | Array<string>, module: Module, options?: Object)

注册一个动态模块。详细介绍

options 可以包含 preserveState: true 以允许保留之前的 state。用于服务端渲染。

unregisterModule

  • unregisterModule(path: string | Array<string>)

卸载一个动态模块。详细介绍

hotUpdate

  • hotUpdate(newOptions: Object)

热替换新的 action 和 mutation。详细介绍