Vuex的API文档
前面的话
本文将详细介绍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.commitdispatch, // 等同于 store.dispatchgetters // 等同于 store.getters }
getters
类型: { [key: string]: Function }
在 store 上注册 getter,getter 方法接受以下参数:
state, // 如果在模块中定义则为模块的局部状态getters, // 等同于 store.getters
当定义在一个模块里时会特别一些
state, // 如果在模块中定义则为模块的局部状态getters, // 等同于 store.gettersrootState // 等同于 store.staterootGetters // 所有 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
创建基于命名空间的组件绑定辅助函数。其返回一个包含 mapState
、mapGetters
、mapActions
和 mapMutations
的对象。它们都已经绑定在了给定的命名空间上
转载于:https://www.cnblogs.com/xiaohuochai/p/7624585.html
Vuex的API文档相关推荐
- Spring Boot 集成Swagger2生成RESTful API文档
Swagger2可以在写代码的同时生成对应的RESTful API文档,方便开发人员参考,另外Swagger2也提供了强大的页面测试功能来调试每个RESTful API. 使用Spring Boot可 ...
- 为TypeScript项目生成API文档
为TypeScript项目生成文档 使用typedoc为TypeScript项目生成API文档. 1. 使用typedoc生成HTML文档 需要安装 typedoc. npm i typedoc 可以 ...
- 各种开发API文档+开发工具
版权声明:本文为博主原创文章,转载请标明出处. https://blog.csdn.net/chaoyu168/article/details/51462377 各种开发API文档+开发工具,需要的自 ...
- 再见丑陋的 SwaggerUI,这款API文档生成神器界面更炫酷,逼格更高!
欢迎关注方志朋的博客,回复"666"获面试宝典 一般在使用 Spring Boot 开发前后端分离项目的时候,都会用到 Swagger.Swagger 是一个规范和完整的框架,用于 ...
- 先写API文档还是先写代码?你需要这款神器Apifox!
代码未动,文档先行 其实大家都知道 API 文档先行的重要性,但是在实践过程中往往会遇到很多困难. 程序员最讨厌的两件事:1. 写文档,2. 别人不写文档.大多数开发人员不愿意写 API 文档的原因是 ...
- 干掉 Postman?测试接口直接生成API文档,这个文档工具真香!
欢迎关注方志朋的博客,回复"666"获面试宝典 实不相瞒我的收藏夹里躺着很多优质的开源项目,我有个爱好平时遇到感兴趣的开源项目都会记录下来,然后有时间在慢慢研究.前几天刚给同事分享 ...
- 还在发愁写API文档?推荐一款阿里腾讯都在用的API管理神器!
欢迎关注方志朋的博客,回复"666"获面试宝典 前言 ❝ 程序员最讨厌的两件事:1. 写文档,2. 别人不写文档.大多数开发人员不愿意写 API 文档的原因:写文档短期收益远低于付 ...
- SpringBoot 第十篇: 用spring Restdocs创建API文档
这篇文章将带你了解如何用spring官方推荐的restdoc去生成api文档.本文创建一个简单的springboot工程,将http接口通过Api文档暴露出来.只需要通过 JUnit单元测试和Spri ...
- windows api中文文档_Web服务开发:Spring集成Swagger,3步自动生成API文档
目录: 1,Spring Boot集成Swagger 2,Swagger接口文档页面 3,常见问题和解决方法 在Sping开发REST接口服务时,API文档是不可缺少的一个重要部分.Swagger框架 ...
- 很安逸的离线API文档查询工具Dash和Zeal
大家开发的时候难免会查询一些文档,看一下API的调用方法等,所以会不同的语言去某一个地方去找,确实很麻烦,今天给大家安逸两款软件,肯定会让你爱不释手! Dash for macOS 官方地址:http ...
最新文章
- AI产品经理需了解的技术知识:语音识别技术(2)
- libev的使用——结合Socket编程
- python适用范围_Python应用范围总结概览
- stack overflow--技术问答网站
- redis实现cache系统实践(六)
- c# mysql ef框架_首页 C# EF6数据库第一-EF试图创建我的数据...
- 99乘法表(java版)
- java 产生随机数_java生成随机数
- android oreo_Android Oreo隐式和显式广播接收器
- mockito模拟依赖注入_Mockito @InjectMocks –模拟依赖注入
- 自己动手开发编译器(四)利用DFA转换表建立扫描器
- 使用FileWriter和BufferedWriter向文本文件中写信息
- win10python安装失败_python3.6 + win10 安装 python-Levenshtein 错误记录
- 2021宇哥八套卷总结—第一套试卷分析
- kernel - regulator
- PFX文件解析及读取、写入、删除相关操作
- 从AOP到Spring AOP
- Asus EeePC X101上网本为MeeGo带来新的生机
- 世界五百强中国上榜公司首次超过美国;现代汽车发布电动汽车品牌IONIQ | 美通企业日报...
- 出水芙蓉,风华绝代----记民国才女林徽因
热门文章
- 2,000,000+在用的这款Chrome插件,到底有多牛逼?
- 变迁是这个时代最好的机遇
- VLC框架总结(一)VLC源码及各modules功能介绍
- 幅频响应 matlab画法,MATLAB环境下频率响应曲线的绘制方法.pdf
- 如何提高python代码运行速度_一行代码让你的python运行速度提高100倍
- 凯撒密码加密,解密的实现,可以在项目上使用
- python-gui-pyqt5的使用方法-6--lambda传递参数的方法:
- python-excel写入代码
- android 注解创建对象,Android ORM 框架:GreenDao 使用详解
- bitmap存入mysql,[MySQL] mysql中bitmap的简单运用