Vuex API 参考

---

Vuex.Store

import Vuex from 'vuex' const store = new Vuex.Store({ ...options })

Vuex.Store 构造选项

state

类型：Object

Vuex store 的根state对象。

Details

mutations

类型：{ [type: string]: Function }

在 store 上注册 mutation，Handler function总是接收 state 作为第一个参数（如果定义在模块中，则作为模块的本地状态），如果有则接收 payload 作为第二个参数。

actions

类型：{ [type: string]: Function }

在 store 上注册 action。Handler function接收一个 context 对象，这个对象提供以下属性：

{ state, // 等同于 store.state，如果在模块中则是本地状态 rootState, // 等同于 store.state，模块中才有 commit, // 等同于 store.commit dispatch, // 等同于 store.dispatch getters // 等同于 store.getters }

getters

类型：{ [key: string]: Function }

在 store 上注册 getter，getter 方法接收一下参数：

注册的 getter 被暴露在 store.getters。

state, // 如果在模块中定义则为模块的本地状态 getters, // 等同于 store.getters rootState // 等同于 store.state

modules

类型：Object

包含了子模块的对象，会被合并到 store，形如：

每个模块可以包含 state 和 mutations，就像根模块的配置。一个模块的状态使用模块的 key 附加到 store 的根状态上。模块的 mutation 和 getter 将接收 module 的本地状态作为第一个参数，而不是根状态，并且模块 action 的 context.state 也指向本地状态。

{ key: { state, mutations, actions?, getters?, modules? }, ... }

plugins

类型：Array

一个插件方法的数组被应用于 store 上。这些插件直接接收 store 作为唯一参数，也可以监听 mutation（用于外部地数据持久化、记录或调试）或者提交 mutation （用于内部数据，例如 websocket 或 某些观察者）。

strict

类型：Boolean

默认值：false

强制 Vuex store 进入严格模式，在严格模式下，在 mutation 处理器以外修改 Vuex state 则会抛出错误。

Vuex.Store Instance Properties

state

• 类型：Object

  The root state. Read only.

getters

• 类型：Object

  暴露注册的 getter，只读。

Vuex.Store 实例方法

commit(类型： string, payload?: any) | commit(mutation: Object)

提交一个 mutation.

dispatch(type: string, payload?: any) | dispatch(action: Object)

分发一个 action。返回 action 方法的返回值，如果多个处理器被触发，那么返回一个 Pormise。

replaceState(state: Object)

替换 store 的根状态，仅用于调试 state。

watch(getter: Function, cb: Function, options?: Object)

响应式的监测一个 getter 方法的返回值，当值改变时调用回调。getter 接收 store 的 state 作为唯一参数。接收类似 vm.$watch 方法的参数的可选对象。

要停止检测，调用该方法的返回值 （watch 的返回值是个方法）。

subscribe(handler: Function)

订阅（注册监听） store 的 mutation。handler 会再每个 mutation 完成后调用，接收 mutation 的描述对象和 经过 mutation 后的状态作为参数：

这是插件中常见的用法。

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

registerModule(path: string | Array, module: Module)

注册一个动态模块。

unregisterModule(path: string | Array)

注销一个动态模块。

hotUpdate(newOptions: Object)

热加载新的 action 和 mutation。

组件绑定助手

• mapState(map: Array | Object): Object

  创建一个组件的计算属性选项，该选项会返回 Vuex store 的子树。

• mapGetters(map: Array | Object): Object

  创建一个组件的计算属性选项，该选项会返回 getter的计算后的值。

• mapActions(map: Array | Object): Object

  创建一个组件的methods选项，该选项返回一个 action。

• mapMutations(map: Array | Object): Object

  创建一个组件的methods选项，该选项提交一个 mutation。