13518219792
这篇文章将为大家详细讲解有关Vuex中API文档说明的示例分析，小编觉得挺实用的，因此分享给大家做个参考，希望大家阅读完这篇文章后可以有所收获。
概述
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 方法接受以下参数：
state, // 如果在模块中定义则为模块的局部状态
getters, // 等同于 store.getters
当定义在一个模块里时会特别一些
state, // 如果在模块中定义则为模块的局部状态
getters, // 等同于 store.getters
rootState // 等同于 store.state
rootGetters // 所有 getters
注册的 getter 暴露为 store.getters
modules类型: Object
包含了子模块的对象，会被合并到 store
{
key: {
state,
namespaced?,
mutations,
actions?,
getters?,
modules?
},
...
}与根模块的选项一样，每个模块也包含 state 和 mutations 选项。模块的状态使用 key 关联到 store 的根状态。模块的 mutation 和 getter 只会接收 module 的局部状态作为第一个参数，而不是根状态，并且模块 action 的 context.state 同样指向局部状态
plugins类型: Array
一个数组，包含应用在 store 上的插件方法。这些插件直接接收 store 作为唯一参数，可以监听 mutation（用于外部地数据持久化、记录或调试）或者提交 mutation （用于内部数据，例如 websocket 或 某些观察者）
strict类型: Boolean
默认值: false
使 Vuex store 进入严格模式，在严格模式下，任何 mutation 处理函数以外修改 Vuex state 都会抛出错误
实例属性state类型: Object
根状态，只读
getters类型: Object
暴露出注册的 getter，只读
实例方法commit(type: string, payload?: any, options?: Object) | commit(mutation: Object, options?: Object)
提交 mutation。options 里可以有 root: true，它允许在命名空间模块里提交根的 mutation
dispatch(type: string, payload?: any, options?: Object) | dispatch(action: Object, options?: Object)
分发 action。options 里可以有 root: true，它允许在命名空间模块里分发根的 action。返回一个解析所有被触发的 action 处理器的 Promise
replaceState(state: Object)
替换 store 的根状态，仅用状态合并或时光旅行调试
watch(getter: Function, cb: Function, options?: Object)
响应式地监测一个 getter 方法的返回值，当值改变时调用回调函数。getter 接收 store 的状态作为唯一参数。接收一个可选的对象参数表示 Vue 的 vm.$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(namespace?: string, map: Array| Object): Object
为组件创建计算属性以返回 Vuex store 中的状态。第一个参数是可选的，可以是一个命名空间字符串
mapGetters(namespace?: string, map: Array| Object): Object
为组件创建计算属性以返回 getter 的返回值。第一个参数是可选的，可以是一个命名空间字符串
mapActions(namespace?: string, map: Array| Object): Object
创建组件方法分发 action。第一个参数是可选的，可以是一个命名空间字符串
mapMutations(namespace?: string, map: Array| Object): Object
创建组件方法提交 mutation。第一个参数是可选的，可以是一个命名空间字符串
createNamespacedHelpers(namespace: string): Object
关于“Vuex中API文档说明的示例分析”这篇文章就分享到这里了，希望以上内容可以对大家有一定的帮助，使各位可以学到更多知识，如果觉得文章不错，请把它分享出去让更多的人看到。
