Vuex.Store 构造器选项

state

  • 类型: Object | Function

    Vuex store 实例的根 state 对象。详细介绍

    如果你传入返回一个对象的函数,其返回的对象会被用作根 state。这在你想要重用 state 对象,尤其是对于重用 module 来说非常有用。详细介绍

mutations

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

    在 store 上注册 mutation,处理函数总是接受 state 作为第一个参数(如果定义在模块中,则为模块的局部状态),payload 作为第二个参数(可选)。

    详细介绍

actions

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

    在 store 上注册 action。处理函数总是接受 context 作为第一个参数,payload 作为第二个参数(可选)。

    context 对象包含以下属性:

    1. {
    2. state, // 等同于 `store.state`,若在模块中则为局部状态
    3. rootState, // 等同于 `store.state`,只存在于模块中
    4. commit, // 等同于 `store.commit`
    5. dispatch, // 等同于 `store.dispatch`
    6. getters, // 等同于 `store.getters`
    7. rootGetters // 等同于 `store.getters`,只存在于模块中
    8. }

    同时如果有第二个参数 payload 的话也能够接收。

    详细介绍

getters

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

在 store 上注册 getter,getter 方法接受以下参数:

  1. state, // 如果在模块中定义则为模块的局部状态
  2. getters, // 等同于 store.getters

当定义在一个模块里时会特别一些:

  1. state, // 如果在模块中定义则为模块的局部状态
  2. getters, // 等同于 store.getters
  3. rootState // 等同于 store.state
  4. rootGetters // 所有 getters

注册的 getter 暴露为 store.getters

详细介绍

modules

  • 类型: Object

    包含了子模块的对象,会被合并到 store,大概长这样:

    1. {
    2. key: {
    3. state,
    4. namespaced?,
    5. mutations,
    6. actions?,
    7. getters?,
    8. modules?
    9. },
    10. ...
    11. }

    与根模块的选项一样,每个模块也包含 statemutations 选项。模块的状态使用 key 关联到 store 的根状态。模块的 mutation 和 getter 只会接收 module 的局部状态作为第一个参数,而不是根状态,并且模块 action 的 context.state 同样指向局部状态。

    详细介绍

plugins

  • 类型: Array<Function>

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

    详细介绍

strict

  • 类型: boolean

  • 默认值: false

    使 Vuex store 进入严格模式,在严格模式下,任何 mutation 处理函数以外修改 Vuex state 都会抛出错误。

    详细介绍

devtools

  • 类型:boolean

    为某个特定的 Vuex 实例打开或关闭 devtools。对于传入 false 的实例来说 Vuex store 不会订阅到 devtools 插件。可用于一个页面中有多个 store 的情况。

    1. {
    2. devtools: false
    3. }