vuex-help

<!DOCTYPE HTML> <html lang="zh-cn" > <head> <meta charset="UTF-8"> <meta content="text/html; charset=utf-8" http-equiv="Content-Type"> <title>API 文档 · Vuex</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta name="description" content=""> <meta name="generator" content="GitBook 3.2.3"> <link rel="stylesheet" href="../gitbook/style.css"> <link rel="stylesheet" href="../gitbook/gitbook-plugin-prism/prism.css"> <link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css"> <link rel="stylesheet" href="../gitbook/gitbook-plugin-theme-vuejs/vue.css"> <meta name="HandheldFriendly" content="true"/> <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no"> <meta name="apple-mobile-web-app-capable" content="yes"> <meta name="apple-mobile-web-app-status-bar-style" content="black"> <link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png"> <link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon"> <link rel="prev" href="hot-reload.html" /> </head> <body> <div class="book"> <div class="book-summary"> <div id="book-search-input" role="search"> <input type="text" placeholder="輸入並搜尋" /> </div> <nav role="navigation"> <script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?zoneid=1673&serve=C6AILKT&placement=vuejs" id="_carbonads_js"></script> <ul class="summary"> <li class="chapter " data-level="1.1" data-path="./"> <a href="./"> Introduction </a> </li> <li class="chapter " data-level="1.2" > <a target="_blank" href="https://github.com/vuejs/vuex/releases"> 更新记录 </a> </li> <li class="chapter " data-level="1.3" data-path="installation.html"> <a href="installation.html"> 安装 </a> </li> <li class="chapter " data-level="1.4" data-path="intro.html"> <a href="intro.html"> Vuex 是什么？ </a> </li> <li class="chapter " data-level="1.5" data-path="getting-started.html"> <a href="getting-started.html"> 开始 </a> </li> <li class="chapter " data-level="1.6" data-path="core-concepts.html"> <a href="core-concepts.html"> 核心概念 </a> <ul class="articles"> <li class="chapter " data-level="1.6.1" data-path="state.html"> <a href="state.html"> State </a> </li> <li class="chapter " data-level="1.6.2" data-path="getters.html"> <a href="getters.html"> Getter </a> </li> <li class="chapter " data-level="1.6.3" data-path="mutations.html"> <a href="mutations.html"> Mutation </a> </li> <li class="chapter " data-level="1.6.4" data-path="actions.html"> <a href="actions.html"> Action </a> </li> <li class="chapter " data-level="1.6.5" data-path="modules.html"> <a href="modules.html"> Module </a> </li> </ul> </li> <li class="chapter " data-level="1.7" data-path="structure.html"> <a href="structure.html"> 项目结构 </a> </li> <li class="chapter " data-level="1.8" data-path="plugins.html"> <a href="plugins.html"> 插件 </a> </li> <li class="chapter " data-level="1.9" data-path="strict.html"> <a href="strict.html"> 严格模式 </a> </li> <li class="chapter " data-level="1.10" data-path="forms.html"> <a href="forms.html"> 表单处理 </a> </li> <li class="chapter " data-level="1.11" data-path="testing.html"> <a href="testing.html"> 测试 </a> </li> <li class="chapter " data-level="1.12" data-path="hot-reload.html"> <a href="hot-reload.html"> 热重载 </a> </li> <li class="chapter active" data-level="1.13" data-path="api.html"> <a href="api.html"> API 文档 </a> </li> <li class="divider"></li> <li> <a href="https://www.gitbook.com" target="blank" class="gitbook-link"> 本書使用 GitBook 釋出 </a> </li> </ul> </nav> </div> <div class="book-body"> <div class="body-inner"> <div class="book-header" role="navigation">  <h1> <a href="." >API 文档</a> </h1> </div> <div class="page-wrapper" tabindex="-1" role="main"> <div class="page-inner"> <div id="book-search-results"> <div class="search-noresults"> <section class="normal markdown-section"> <h1 id="api-参考">API 参考</h1> <h3 id="vuexstore">Vuex.Store</h3> <pre class="language-"><code class="lang-js">import Vuex from 'vuex' const store = new Vuex.Store({ ...options }) </code></pre> <h3 id="vuexstore-构造器选项">Vuex.Store 构造器选项</h3> <ul> <li>state <ul> <li>类型: <code>Object | Function</code> Vuex store 实例的根 state 对象。<a href="state.html">详细介绍</a> 如果你传入返回一个对象的函数，其返回的对象会被用作根 state。这在你想要重用 state 对象，尤其是对于重用 module 来说非常有用。<a href="modules.html#模块重用">详细介绍</a> </li> </ul> </li> <li>mutations <ul> <li>类型: <code>{ [type: string]: Function }</code> 在 store 上注册 mutation，处理函数总是接受 <code>state</code> 作为第一个参数（如果定义在模块中，则为模块的局部状态），<code>payload</code> 作为第二个参数（可选）。 <a href="mutations.html">详细介绍</a> </li> </ul> </li> <li>actions <ul> <li>类型: <code>{ [type: string]: Function }</code> 在 store 上注册 action。处理函数总是接受 <code>context</code> 作为第一个参数，<code>payload</code> 作为第二个参数（可选）。 <code>context</code> 对象包含以下属性： <pre class="language-"><code class="lang-js">{ state, // 等同于 `store.state`，若在模块中则为局部状态 rootState, // 等同于 `store.state`，只存在于模块中 commit, // 等同于 `store.commit` dispatch, // 等同于 `store.dispatch` getters, // 等同于 `store.getters` rootGetters // 等同于 `store.getters`，只存在于模块中 } </code></pre> <a href="actions.html">详细介绍</a> </li> </ul> </li> <li>getters <ul> <li>类型: <code>{ [key: string]: Function }</code></li> </ul> 在 store 上注册 getter，getter 方法接受以下参数： <pre class="language-"><code> state, // 如果在模块中定义则为模块的局部状态 getters, // 等同于 store.getters </code></pre> 当定义在一个模块里时会特别一些： <pre class="language-"><code> state, // 如果在模块中定义则为模块的局部状态 getters, // 等同于 store.getters rootState // 等同于 store.state rootGetters // 所有 getters </code></pre> 注册的 getter 暴露为 <code>store.getters</code>。 <a href="getters.html">详细介绍</a> </li> <li>modules <ul> <li>类型: <code>Object</code> 包含了子模块的对象，会被合并到 store，大概长这样： <pre class="language-"><code class="lang-js">{ key: { state, namespaced?, mutations, actions?, getters?, modules? }, ... } </code></pre> 与根模块的选项一样，每个模块也包含 <code>state</code> 和 <code>mutations</code> 选项。模块的状态使用 key 关联到 store 的根状态。模块的 mutation 和 getter 只会接收 module 的局部状态作为第一个参数，而不是根状态，并且模块 action 的 <code>context.state</code> 同样指向局部状态。 <a href="modules.html">详细介绍</a> </li> </ul> </li> <li>plugins <ul> <li>类型: <code>Array<Function></code> 一个数组，包含应用在 store 上的插件方法。这些插件直接接收 store 作为唯一参数，可以监听 mutation（用于外部地数据持久化、记录或调试）或者提交 mutation （用于内部数据，例如 websocket 或 某些观察者） <a href="plugins.html">详细介绍</a> </li> </ul> </li> <li>strict <ul> <li>类型: <code>Boolean</code></li> <li>默认值: <code>false</code> 使 Vuex store 进入严格模式，在严格模式下，任何 mutation 处理函数以外修改 Vuex state 都会抛出错误。 <a href="strict.html">详细介绍</a> </li> </ul> </li> </ul> <h3 id="vuexstore-实例属性">Vuex.Store 实例属性</h3> <ul> <li>state <ul> <li>类型: <code>Object</code> 根状态，只读。 </li> </ul> </li> <li>getters <ul> <li>类型: <code>Object</code> 暴露出注册的 getter，只读。 </li> </ul> </li> </ul> <h3 id="vuexstore-实例方法">Vuex.Store 实例方法</h3> <ul> <li><code>commit(type: string, payload?: any, options?: Object) | commit(mutation: Object, options?: Object)</code> 提交 mutation。<code>options</code> 里可以有 <code>root: true</code>，它允许在<a href="modules.html#命名空间">命名空间模块</a>里提交根的 mutation。<a href="mutations.html">详细介绍</a> </li> <li><code>dispatch(type: string, payload?: any, options?: Object) | dispatch(action: Object, options?: Object)</code> 分发 action。<code>options</code> 里可以有 <code>root: true</code>，它允许在<a href="modules.html#命名空间">命名空间模块</a>里分发根的 action。返回一个解析所有被触发的 action 处理器的 Promise。<a href="actions.html">详细介绍</a> </li> <li><code>replaceState(state: Object)</code> 替换 store 的根状态，仅用状态合并或时光旅行调试。 </li> <li><code>watch(getter: Function, cb: Function, options?: Object)</code> 响应式地监测一个 getter 方法的返回值，当值改变时调用回调函数。Getter 接收 store 的 state 作为第一个参数，其 getter 作为第二个参数。最后接收一个可选的对象参数表示 Vue 的 <code>vm.$watch</code> 方法的参数。 要停止监测，直接调用返回的处理函数。 </li> <li><code>subscribe(handler: Function)</code> 注册监听 store 的 mutation。<code>handler</code> 会在每个 mutation 完成后调用，接收 mutation 和经过 mutation 后的状态作为参数： <pre class="language-"><code class="lang-js">store.subscribe((mutation, state) => { console.log(mutation.type) console.log(mutation.payload) }) </code></pre> 通常用于插件。<a href="plugins.html">详细介绍</a> </li> <li><code>subscribeAction(handler: Function)</code> <blockquote> 2.5.0 新增 </blockquote> 订阅 store 的 action。<code>handler</code> 会在每个 action 分发的时候调用并接收 action 描述和当前的 store 的 state 这两个参数： <pre class="language-"><code class="lang-js">store.subscribeAction((action, state) => { console.log(action.type) console.log(action.payload) }) </code></pre> 该功能常用于插件。<a href="plugins.html">详细介绍</a> </li> <li><code>registerModule(path: string | Array<string>, module: Module, options?: Object)</code> 注册一个动态模块。<a href="modules.html#模块动态注册">详细介绍</a> <code>options</code> 可以包含 <code>preserveState: true</code> 以允许保留之前的 state。用于服务端渲染。 </li> <li><code>unregisterModule(path: string | Array<string>)</code> 卸载一个动态模块。<a href="modules.html#模块动态注册">详细介绍</a> </li> <li><code>hotUpdate(newOptions: Object)</code> 热替换新的 action 和 mutation。<a href="hot-reload.html">详细介绍</a> </li> </ul> <h3 id="组件绑定的辅助函数">组件绑定的辅助函数</h3> <ul> <li><code>mapState(namespace?: string, map: Array<string> | Object): Object</code> 为组件创建计算属性以返回 Vuex store 中的状态。<a href="state.html#mapstate-辅助函数">详细介绍</a> 第一个参数是可选的，可以是一个命名空间字符串。<a href="modules.html#带命名空间的绑定函数">详细介绍</a> </li> <li><code>mapGetters(namespace?: string, map: Array<string> | Object): Object</code> 为组件创建计算属性以返回 getter 的返回值。<a href="getters.html#mapgetters-辅助函数">详细介绍</a> 第一个参数是可选的，可以是一个命名空间字符串。<a href="modules.html#带命名空间的绑定函数">详细介绍</a> </li> <li><code>mapActions(namespace?: string, map: Array<string> | Object): Object</code> 创建组件方法分发 action。<a href="actions.html#在组件中分发-action">详细介绍</a> 第一个参数是可选的，可以是一个命名空间字符串。<a href="modules.html#带命名空间的绑定函数">详细介绍</a> </li> <li><code>mapMutations(namespace?: string, map: Array<string> | Object): Object</code> 创建组件方法提交 mutation。<a href="mutations.html#在组件中提交-mutation">详细介绍</a> 第一个参数是可选的，可以是一个命名空间字符串。<a href="modules.html#带命名空间的绑定函数">详细介绍</a> </li> <li><code>createNamespacedHelpers(namespace: string): Object</code> 创建基于命名空间的组件绑定辅助函数。其返回一个包含 <code>mapState</code>、<code>mapGetters</code>、<code>mapActions</code> 和 <code>mapMutations</code> 的对象。它们都已经绑定在了给定的命名空间上。<a href="modules.html#带命名空间的绑定函数">详细介绍</a> </li> </ul> </section> </div> <div class="search-results"> <div class="has-results"> <h1 class="search-results-title"> results matching ""</h1> <ul class="search-results-list"></ul> </div> <div class="no-results"> <h1 class="search-results-title">No results matching ""</h1> </div> </div> </div> </div> </div> <script src="//m.servedby-buysellads.com/monetization.js" type="text/javascript"></script> <div class="bsa-cpc"></div> <script> (function(){ if(typeof _bsa !== 'undefined' && _bsa) { _bsa.init('default', 'CKYD62QM', 'placement:vuejsorg', { target: '.bsa-cpc', align: 'horizontal', disable_css: 'true' }); } })(); </script> </div> <a href="hot-reload.html" class="navigation navigation-prev navigation-unique" aria-label="Previous page: 热重载"> </a> </div> <script> var gitbook = gitbook || []; gitbook.push(function() { gitbook.page.hasChanged({"page":{"title":"API 文档","level":"1.13","depth":1,"previous":{"title":"热重载","level":"1.12","depth":1,"path":"hot-reload.md","ref":"hot-reload.md","articles":[]},"dir":"ltr"},"config":{"plugins":["edit-link","prism","-highlight","github","-highlight","github"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"prism":{},"github":{"url":"https://github.com/vuejs/vuex/"},"livereload":{},"search":{},"theme-vuejs":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":false,"twitter":false,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"edit-link":{"label":"编辑此页面","base":"https://github.com/vuejs/vuex/tree/dev/docs"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Vuex","language":"zh-cn","links":{"sharing":{"facebook":false,"twitter":false}},"gitbook":"2.x.x"},"file":{"path":"api.md","mtime":"2018-02-17T07:20:49.000Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-03-02T20:43:43.208Z"},"basePath":".","book":{"language":"zh-cn"}}); }); </script> </div> <script src="../gitbook/gitbook.js"></script> <script src="../gitbook/theme.js"></script> <script src="../gitbook/gitbook-plugin-edit-link/plugin.js"></script> <script src="../gitbook/gitbook-plugin-github/plugin.js"></script> <script src="../gitbook/gitbook-plugin-livereload/plugin.js"></script> <script src="../gitbook/gitbook-plugin-search/search-engine.js"></script> <script src="../gitbook/gitbook-plugin-search/search.js"></script> <script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script> <script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script> <script src="../gitbook/gitbook-plugin-sharing/buttons.js"></script> </body> </html>