Vuex的API文档说明详解

(编辑：jimmy 日期: 2025/11/6 浏览：2)

概述

import Vuex from 'vuex'

const store = new Vuex.Store({ ...options })

构造器选项

state

类型: Object

Vuex store 实例的根 state 对象

mutations

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

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

actions

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

在 store 上注册 action。处理函数接受一个 context 对象，包含以下属性：

{
 state,   // 等同于 store.state, 若在模块中则为局部状态
 rootState, // 等同于 store.state, 只存在于模块中
 commit,  // 等同于 store.commit
 dispatch, // 等同于 store.dispatch
 getters  // 等同于 store.getters
}

getters

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

在 store 上注册 getter，getter 方法接受以下参数：

"htmlcode">

{
 key: {
  state,
  namespaced"htmlcode">

commit(type: string, payload"htmlcode">

dispatch(type: string, payload"htmlcode">

replaceState(state: Object)



替换 store 的根状态，仅用状态合并或时光旅行调试


watch(getter: Function, cb: Function, options"htmlcode">

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<string>, module: Module)



注册一个动态模块


unregisterModule(path: string | Array<string>)



卸载一个动态模块


hotUpdate(newOptions: Object)



热替换新的 action 和 mutation
辅助函数


mapState(namespace"htmlcode">

mapGetters(namespace"htmlcode">

mapActions(namespace"htmlcode">

mapMutations(namespace"htmlcode">

createNamespacedHelpers(namespace: string): Object


更多关于VUEX方面的相关知识请点击下面的相关链接




        
            上一篇：vue路由传参的基本实现方式小结【三种方式】
            下一篇：如何实现iframe父子传参通信