Vuex的API文档说明详解


Posted in Javascript onFebruary 05, 2020

概述

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<Function>

一个数组,包含应用在 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<string>, module: Module)

注册一个动态模块

unregisterModule(path: string | Array<string>)

卸载一个动态模块

hotUpdate(newOptions: Object)

热替换新的 action 和 mutation

辅助函数

mapState(namespace?: string, map: Array<string> | Object): Object

为组件创建计算属性以返回 Vuex store 中的状态。第一个参数是可选的,可以是一个命名空间字符串

mapGetters(namespace?: string, map: Array<string> | Object): Object

为组件创建计算属性以返回 getter 的返回值。第一个参数是可选的,可以是一个命名空间字符串

mapActions(namespace?: string, map: Array<string> | Object): Object

创建组件方法分发 action。第一个参数是可选的,可以是一个命名空间字符串

mapMutations(namespace?: string, map: Array<string> | Object): Object

创建组件方法提交 mutation。第一个参数是可选的,可以是一个命名空间字符串

createNamespacedHelpers(namespace: string): Object

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

Javascript 相关文章推荐
jQuery 性能优化手册 推荐
Feb 23 Javascript
jquery ajax,ashx,json的用法总结
Feb 12 Javascript
jQuery DOM删除节点操作指南
Mar 03 Javascript
用JavaScript实现页面重定向功能的教程
Jun 04 Javascript
简单实现异步编程promise模式
Jul 31 Javascript
为什么JavaScript没有块级作用域
May 22 Javascript
ThinkJS中如何使用MongoDB的CURD操作
Dec 13 Javascript
ajax实现动态下拉框示例
Jan 10 Javascript
简单谈谈axios中的get,post方法
Jun 25 Javascript
在Vue 中使用Typescript的示例代码
Sep 10 Javascript
p5.js绘制旋转的正方形
Oct 23 Javascript
Websocket 向指定用户发消息的方法
Jan 09 Javascript
如何实现iframe父子传参通信
Feb 05 #Javascript
JavaScript对象原型链原理详解
Feb 05 #Javascript
基于Vue的侧边目录组件的实现
Feb 05 #Javascript
Js视频播放器插件Video.js使用方法详解
Feb 04 #Javascript
jQuery单页面文字搜索插件jquery.fullsearch.js的使用方法
Feb 04 #jQuery
JS代码优化的8点建议
Feb 04 #Javascript
9种方法优化jQuery代码详解
Feb 04 #jQuery
You might like
C# Assembly类访问程序集信息
2009/06/13 PHP
让ThinkPHP支持大小写url地址访问的方法
2014/10/31 PHP
PHP设计模式之工厂模式与单例模式
2016/09/28 PHP
Laravel5.1自定义500错误页面示例
2016/10/09 PHP
PhpStorm+xdebug+postman调试技巧分享
2020/09/15 PHP
在IE中调用javascript打开Excel的代码(downmoon原作)
2007/04/02 Javascript
使用jQuery全局事件ajaxStart为特定请求实现提示效果的代码
2010/12/30 Javascript
Iframe自适应高度绝对好使的代码 兼容IE,遨游,火狐
2011/01/27 Javascript
Javascript中的Array数组对象详谈
2014/03/03 Javascript
jQuery子窗体取得父窗体元素的方法
2015/05/11 Javascript
Extjs实现下拉菜单效果
2016/04/01 Javascript
深入理解JS正则表达式---分组
2016/07/18 Javascript
微信小程序 wx.request(object) API详解及实例代码
2016/09/30 Javascript
vue.js 表格分页ajax 异步加载数据
2016/10/18 Javascript
arcgis for js 修改infowindow样式的方法
2016/11/02 Javascript
vue多种弹框的弹出形式的示例代码
2017/09/18 Javascript
vue--vuex详解
2019/04/15 Javascript
JS实现压缩上传图片base64长度功能
2019/12/03 Javascript
在Django框架中编写Context处理器的方法
2015/07/20 Python
遗传算法python版
2018/03/19 Python
Python中的集合介绍
2019/01/28 Python
python使用百度文字识别功能方法详解
2019/07/23 Python
Python 中pandas索引切片读取数据缺失数据处理问题
2019/10/09 Python
python分布式爬虫中消息队列知识点详解
2020/11/26 Python
html5中如何将图片的绝对路径转换成文件对象
2018/01/11 HTML / CSS
Sam’s Club山姆会员商店:沃尔玛旗下高端会员制商店
2017/01/16 全球购物
澳大利亚旅游网站:Lastminute
2017/08/07 全球购物
意大利体育用品和运动服网上商店:Maxi Sport
2019/09/14 全球购物
阿里巴巴美国:Alibaba美国
2019/11/24 全球购物
计算机专业自我鉴定
2013/10/15 职场文书
理财学专业自荐书
2014/06/28 职场文书
银行求职自荐信
2014/06/30 职场文书
2015年办公室个人工作总结
2015/04/20 职场文书
学校元旦晚会开场白
2015/05/29 职场文书
网络研修随笔感言
2015/11/18 职场文书
2016年秋季运动会广播稿
2015/12/21 职场文书