api.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661
  1. <!DOCTYPE HTML>
  2. <html lang="zh-cn" >
  3. <head>
  4. <meta charset="UTF-8">
  5. <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
  6. <title>API 文档 · Vuex</title>
  7. <meta http-equiv="X-UA-Compatible" content="IE=edge" />
  8. <meta name="description" content="">
  9. <meta name="generator" content="GitBook 3.2.2">
  10. <link rel="stylesheet" href="../gitbook/style.css">
  11. <link rel="stylesheet" href="../gitbook/gitbook-plugin-prism/prism.css">
  12. <link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css">
  13. <link rel="stylesheet" href="../gitbook/gitbook-plugin-theme-vuejs/vue.css">
  14. <meta name="HandheldFriendly" content="true"/>
  15. <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
  16. <meta name="apple-mobile-web-app-capable" content="yes">
  17. <meta name="apple-mobile-web-app-status-bar-style" content="black">
  18. <link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png">
  19. <link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">
  20. <link rel="prev" href="hot-reload.html" />
  21. </head>
  22. <body>
  23. <div class="book">
  24. <div class="book-summary">
  25. <div id="book-search-input" role="search">
  26. <input type="text" placeholder="輸入並搜尋" />
  27. </div>
  28. <nav role="navigation">
  29. <script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?zoneid=1673&serve=C6AILKT&placement=vuejs" id="_carbonads_js"></script>
  30. <ul class="summary">
  31. <li class="chapter " data-level="1.1" data-path="./">
  32. <a href="./">
  33. Introduction
  34. </a>
  35. </li>
  36. <li class="chapter " data-level="1.2" >
  37. <a target="_blank" href="https://github.com/vuejs/vuex/releases">
  38. 更新记录
  39. </a>
  40. </li>
  41. <li class="chapter " data-level="1.3" data-path="installation.html">
  42. <a href="installation.html">
  43. 安装
  44. </a>
  45. </li>
  46. <li class="chapter " data-level="1.4" data-path="intro.html">
  47. <a href="intro.html">
  48. Vuex 是什么?
  49. </a>
  50. </li>
  51. <li class="chapter " data-level="1.5" data-path="getting-started.html">
  52. <a href="getting-started.html">
  53. 开始
  54. </a>
  55. </li>
  56. <li class="chapter " data-level="1.6" data-path="core-concepts.html">
  57. <a href="core-concepts.html">
  58. 核心概念
  59. </a>
  60. <ul class="articles">
  61. <li class="chapter " data-level="1.6.1" data-path="state.html">
  62. <a href="state.html">
  63. State
  64. </a>
  65. </li>
  66. <li class="chapter " data-level="1.6.2" data-path="getters.html">
  67. <a href="getters.html">
  68. Getter
  69. </a>
  70. </li>
  71. <li class="chapter " data-level="1.6.3" data-path="mutations.html">
  72. <a href="mutations.html">
  73. Mutation
  74. </a>
  75. </li>
  76. <li class="chapter " data-level="1.6.4" data-path="actions.html">
  77. <a href="actions.html">
  78. Action
  79. </a>
  80. </li>
  81. <li class="chapter " data-level="1.6.5" data-path="modules.html">
  82. <a href="modules.html">
  83. Module
  84. </a>
  85. </li>
  86. </ul>
  87. </li>
  88. <li class="chapter " data-level="1.7" data-path="structure.html">
  89. <a href="structure.html">
  90. 项目结构
  91. </a>
  92. </li>
  93. <li class="chapter " data-level="1.8" data-path="plugins.html">
  94. <a href="plugins.html">
  95. 插件
  96. </a>
  97. </li>
  98. <li class="chapter " data-level="1.9" data-path="strict.html">
  99. <a href="strict.html">
  100. 严格模式
  101. </a>
  102. </li>
  103. <li class="chapter " data-level="1.10" data-path="forms.html">
  104. <a href="forms.html">
  105. 表单处理
  106. </a>
  107. </li>
  108. <li class="chapter " data-level="1.11" data-path="testing.html">
  109. <a href="testing.html">
  110. 测试
  111. </a>
  112. </li>
  113. <li class="chapter " data-level="1.12" data-path="hot-reload.html">
  114. <a href="hot-reload.html">
  115. 热重载
  116. </a>
  117. </li>
  118. <li class="chapter active" data-level="1.13" data-path="api.html">
  119. <a href="api.html">
  120. API 文档
  121. </a>
  122. </li>
  123. <li class="divider"></li>
  124. <li>
  125. <a href="https://www.gitbook.com" target="blank" class="gitbook-link">
  126. 本書使用 GitBook 釋出
  127. </a>
  128. </li>
  129. </ul>
  130. </nav>
  131. </div>
  132. <div class="book-body">
  133. <div class="body-inner">
  134. <div class="book-header" role="navigation">
  135. <!-- Title -->
  136. <h1>
  137. <i class="fa fa-circle-o-notch fa-spin"></i>
  138. <a href="." >API 文档</a>
  139. </h1>
  140. </div>
  141. <div class="page-wrapper" tabindex="-1" role="main">
  142. <div class="page-inner">
  143. <div id="book-search-results">
  144. <div class="search-noresults">
  145. <section class="normal markdown-section">
  146. <h1 id="api-&#x53C2;&#x8003;">API &#x53C2;&#x8003;</h1>
  147. <h3 id="vuexstore">Vuex.Store</h3>
  148. <pre class="language-"><code class="lang-js"><span class="token keyword">import</span> Vuex <span class="token keyword">from</span> <span class="token string">&apos;vuex&apos;</span>
  149. <span class="token keyword">const</span> store <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Vuex<span class="token punctuation">.</span>Store</span><span class="token punctuation">(</span><span class="token punctuation">{</span> <span class="token operator">...</span>options <span class="token punctuation">}</span><span class="token punctuation">)</span>
  150. </code></pre>
  151. <h3 id="vuexstore-&#x6784;&#x9020;&#x5668;&#x9009;&#x9879;">Vuex.Store &#x6784;&#x9020;&#x5668;&#x9009;&#x9879;</h3>
  152. <ul>
  153. <li><p><strong>state</strong></p>
  154. <ul>
  155. <li><p>&#x7C7B;&#x578B;: <code>Object | Function</code></p>
  156. <p>Vuex store &#x5B9E;&#x4F8B;&#x7684;&#x6839; state &#x5BF9;&#x8C61;&#x3002;<a href="state.html">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  157. <p>&#x5982;&#x679C;&#x4F60;&#x4F20;&#x5165;&#x8FD4;&#x56DE;&#x4E00;&#x4E2A;&#x5BF9;&#x8C61;&#x7684;&#x51FD;&#x6570;&#xFF0C;&#x5176;&#x8FD4;&#x56DE;&#x7684;&#x5BF9;&#x8C61;&#x4F1A;&#x88AB;&#x7528;&#x4F5C;&#x6839; state&#x3002;&#x8FD9;&#x5728;&#x4F60;&#x60F3;&#x8981;&#x91CD;&#x7528; state &#x5BF9;&#x8C61;&#xFF0C;&#x5C24;&#x5176;&#x662F;&#x5BF9;&#x4E8E;&#x91CD;&#x7528; module &#x6765;&#x8BF4;&#x975E;&#x5E38;&#x6709;&#x7528;&#x3002;<a href="modules.html#&#x6A21;&#x5757;&#x91CD;&#x7528;">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  158. </li>
  159. </ul>
  160. </li>
  161. <li><p><strong>mutations</strong></p>
  162. <ul>
  163. <li><p>&#x7C7B;&#x578B;: <code>{ [type: string]: Function }</code></p>
  164. <p>&#x5728; store &#x4E0A;&#x6CE8;&#x518C; mutation&#xFF0C;&#x5904;&#x7406;&#x51FD;&#x6570;&#x603B;&#x662F;&#x63A5;&#x53D7; <code>state</code> &#x4F5C;&#x4E3A;&#x7B2C;&#x4E00;&#x4E2A;&#x53C2;&#x6570;&#xFF08;&#x5982;&#x679C;&#x5B9A;&#x4E49;&#x5728;&#x6A21;&#x5757;&#x4E2D;&#xFF0C;&#x5219;&#x4E3A;&#x6A21;&#x5757;&#x7684;&#x5C40;&#x90E8;&#x72B6;&#x6001;&#xFF09;&#xFF0C;<code>payload</code> &#x4F5C;&#x4E3A;&#x7B2C;&#x4E8C;&#x4E2A;&#x53C2;&#x6570;&#xFF08;&#x53EF;&#x9009;&#xFF09;&#x3002;</p>
  165. <p><a href="mutations.html">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  166. </li>
  167. </ul>
  168. </li>
  169. <li><p><strong>actions</strong></p>
  170. <ul>
  171. <li><p>&#x7C7B;&#x578B;: <code>{ [type: string]: Function }</code></p>
  172. <p>&#x5728; store &#x4E0A;&#x6CE8;&#x518C; action&#x3002;&#x5904;&#x7406;&#x51FD;&#x6570;&#x603B;&#x662F;&#x63A5;&#x53D7; <code>context</code> &#x4F5C;&#x4E3A;&#x7B2C;&#x4E00;&#x4E2A;&#x53C2;&#x6570;&#xFF0C;<code>payload</code> &#x4F5C;&#x4E3A;&#x7B2C;&#x4E8C;&#x4E2A;&#x53C2;&#x6570;&#xFF08;&#x53EF;&#x9009;&#xFF09;&#x3002;</p>
  173. <p><code>context</code> &#x5BF9;&#x8C61;&#x5305;&#x542B;&#x4EE5;&#x4E0B;&#x5C5E;&#x6027;&#xFF1A;</p>
  174. <pre class="language-"><code class="lang-js"><span class="token punctuation">{</span>
  175. state<span class="token punctuation">,</span> <span class="token comment" spellcheck="true">// &#x7B49;&#x540C;&#x4E8E; `store.state`&#xFF0C;&#x82E5;&#x5728;&#x6A21;&#x5757;&#x4E2D;&#x5219;&#x4E3A;&#x5C40;&#x90E8;&#x72B6;&#x6001;</span>
  176. rootState<span class="token punctuation">,</span> <span class="token comment" spellcheck="true">// &#x7B49;&#x540C;&#x4E8E; `store.state`&#xFF0C;&#x53EA;&#x5B58;&#x5728;&#x4E8E;&#x6A21;&#x5757;&#x4E2D;</span>
  177. commit<span class="token punctuation">,</span> <span class="token comment" spellcheck="true">// &#x7B49;&#x540C;&#x4E8E; `store.commit`</span>
  178. dispatch<span class="token punctuation">,</span> <span class="token comment" spellcheck="true">// &#x7B49;&#x540C;&#x4E8E; `store.dispatch`</span>
  179. getters<span class="token punctuation">,</span> <span class="token comment" spellcheck="true">// &#x7B49;&#x540C;&#x4E8E; `store.getters`</span>
  180. rootGetters <span class="token comment" spellcheck="true">// &#x7B49;&#x540C;&#x4E8E; `store.getters`&#xFF0C;&#x53EA;&#x5B58;&#x5728;&#x4E8E;&#x6A21;&#x5757;&#x4E2D;</span>
  181. <span class="token punctuation">}</span>
  182. </code></pre>
  183. <p>&#x540C;&#x65F6;&#x5982;&#x679C;&#x6709;&#x7B2C;&#x4E8C;&#x4E2A;&#x53C2;&#x6570; <code>payload</code> &#x7684;&#x8BDD;&#x4E5F;&#x80FD;&#x591F;&#x63A5;&#x6536;&#x3002;</p>
  184. <p><a href="actions.html">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  185. </li>
  186. </ul>
  187. </li>
  188. <li><p><strong>getters</strong></p>
  189. <ul>
  190. <li>&#x7C7B;&#x578B;: <code>{ [key: string]: Function }</code></li>
  191. </ul>
  192. <p>&#x5728; store &#x4E0A;&#x6CE8;&#x518C; getter&#xFF0C;getter &#x65B9;&#x6CD5;&#x63A5;&#x53D7;&#x4EE5;&#x4E0B;&#x53C2;&#x6570;&#xFF1A;</p>
  193. <pre class="language-"><code> state, // &#x5982;&#x679C;&#x5728;&#x6A21;&#x5757;&#x4E2D;&#x5B9A;&#x4E49;&#x5219;&#x4E3A;&#x6A21;&#x5757;&#x7684;&#x5C40;&#x90E8;&#x72B6;&#x6001;
  194. getters, // &#x7B49;&#x540C;&#x4E8E; store.getters
  195. </code></pre><p> &#x5F53;&#x5B9A;&#x4E49;&#x5728;&#x4E00;&#x4E2A;&#x6A21;&#x5757;&#x91CC;&#x65F6;&#x4F1A;&#x7279;&#x522B;&#x4E00;&#x4E9B;&#xFF1A;</p>
  196. <pre class="language-"><code> state, // &#x5982;&#x679C;&#x5728;&#x6A21;&#x5757;&#x4E2D;&#x5B9A;&#x4E49;&#x5219;&#x4E3A;&#x6A21;&#x5757;&#x7684;&#x5C40;&#x90E8;&#x72B6;&#x6001;
  197. getters, // &#x7B49;&#x540C;&#x4E8E; store.getters
  198. rootState // &#x7B49;&#x540C;&#x4E8E; store.state
  199. rootGetters // &#x6240;&#x6709; getters
  200. </code></pre><p> &#x6CE8;&#x518C;&#x7684; getter &#x66B4;&#x9732;&#x4E3A; <code>store.getters</code>&#x3002;</p>
  201. <p> <a href="getters.html">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  202. </li>
  203. <li><p><strong>modules</strong></p>
  204. <ul>
  205. <li><p>&#x7C7B;&#x578B;: <code>Object</code></p>
  206. <p>&#x5305;&#x542B;&#x4E86;&#x5B50;&#x6A21;&#x5757;&#x7684;&#x5BF9;&#x8C61;&#xFF0C;&#x4F1A;&#x88AB;&#x5408;&#x5E76;&#x5230; store&#xFF0C;&#x5927;&#x6982;&#x957F;&#x8FD9;&#x6837;&#xFF1A;</p>
  207. <pre class="language-"><code class="lang-js"><span class="token punctuation">{</span>
  208. key<span class="token punctuation">:</span> <span class="token punctuation">{</span>
  209. state<span class="token punctuation">,</span>
  210. namespaced<span class="token operator">?</span><span class="token punctuation">,</span>
  211. mutations<span class="token punctuation">,</span>
  212. actions<span class="token operator">?</span><span class="token punctuation">,</span>
  213. getters<span class="token operator">?</span><span class="token punctuation">,</span>
  214. modules<span class="token operator">?</span>
  215. <span class="token punctuation">}</span><span class="token punctuation">,</span>
  216. <span class="token operator">...</span>
  217. <span class="token punctuation">}</span>
  218. </code></pre>
  219. <p>&#x4E0E;&#x6839;&#x6A21;&#x5757;&#x7684;&#x9009;&#x9879;&#x4E00;&#x6837;&#xFF0C;&#x6BCF;&#x4E2A;&#x6A21;&#x5757;&#x4E5F;&#x5305;&#x542B; <code>state</code> &#x548C; <code>mutations</code> &#x9009;&#x9879;&#x3002;&#x6A21;&#x5757;&#x7684;&#x72B6;&#x6001;&#x4F7F;&#x7528; key &#x5173;&#x8054;&#x5230; store &#x7684;&#x6839;&#x72B6;&#x6001;&#x3002;&#x6A21;&#x5757;&#x7684; mutation &#x548C; getter &#x53EA;&#x4F1A;&#x63A5;&#x6536; module &#x7684;&#x5C40;&#x90E8;&#x72B6;&#x6001;&#x4F5C;&#x4E3A;&#x7B2C;&#x4E00;&#x4E2A;&#x53C2;&#x6570;&#xFF0C;&#x800C;&#x4E0D;&#x662F;&#x6839;&#x72B6;&#x6001;&#xFF0C;&#x5E76;&#x4E14;&#x6A21;&#x5757; action &#x7684; <code>context.state</code> &#x540C;&#x6837;&#x6307;&#x5411;&#x5C40;&#x90E8;&#x72B6;&#x6001;&#x3002;</p>
  220. <p><a href="modules.html">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  221. </li>
  222. </ul>
  223. </li>
  224. <li><p><strong>plugins</strong></p>
  225. <ul>
  226. <li><p>&#x7C7B;&#x578B;: <code>Array<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>Function</span><span class="token punctuation">&gt;</span></span></code></p>
  227. <p>&#x4E00;&#x4E2A;&#x6570;&#x7EC4;&#xFF0C;&#x5305;&#x542B;&#x5E94;&#x7528;&#x5728; store &#x4E0A;&#x7684;&#x63D2;&#x4EF6;&#x65B9;&#x6CD5;&#x3002;&#x8FD9;&#x4E9B;&#x63D2;&#x4EF6;&#x76F4;&#x63A5;&#x63A5;&#x6536; store &#x4F5C;&#x4E3A;&#x552F;&#x4E00;&#x53C2;&#x6570;&#xFF0C;&#x53EF;&#x4EE5;&#x76D1;&#x542C; mutation&#xFF08;&#x7528;&#x4E8E;&#x5916;&#x90E8;&#x5730;&#x6570;&#x636E;&#x6301;&#x4E45;&#x5316;&#x3001;&#x8BB0;&#x5F55;&#x6216;&#x8C03;&#x8BD5;&#xFF09;&#x6216;&#x8005;&#x63D0;&#x4EA4; mutation &#xFF08;&#x7528;&#x4E8E;&#x5185;&#x90E8;&#x6570;&#x636E;&#xFF0C;&#x4F8B;&#x5982; websocket &#x6216; &#x67D0;&#x4E9B;&#x89C2;&#x5BDF;&#x8005;&#xFF09;</p>
  228. <p><a href="plugins.html">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  229. </li>
  230. </ul>
  231. </li>
  232. <li><p><strong>strict</strong></p>
  233. <ul>
  234. <li>&#x7C7B;&#x578B;: <code>Boolean</code></li>
  235. <li><p>&#x9ED8;&#x8BA4;&#x503C;: <code>false</code></p>
  236. <p>&#x4F7F; Vuex store &#x8FDB;&#x5165;&#x4E25;&#x683C;&#x6A21;&#x5F0F;&#xFF0C;&#x5728;&#x4E25;&#x683C;&#x6A21;&#x5F0F;&#x4E0B;&#xFF0C;&#x4EFB;&#x4F55; mutation &#x5904;&#x7406;&#x51FD;&#x6570;&#x4EE5;&#x5916;&#x4FEE;&#x6539; Vuex state &#x90FD;&#x4F1A;&#x629B;&#x51FA;&#x9519;&#x8BEF;&#x3002;</p>
  237. <p><a href="strict.html">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  238. </li>
  239. </ul>
  240. </li>
  241. </ul>
  242. <h3 id="vuexstore-&#x5B9E;&#x4F8B;&#x5C5E;&#x6027;">Vuex.Store &#x5B9E;&#x4F8B;&#x5C5E;&#x6027;</h3>
  243. <ul>
  244. <li><p><strong>state</strong></p>
  245. <ul>
  246. <li><p>&#x7C7B;&#x578B;: <code>Object</code></p>
  247. <p>&#x6839;&#x72B6;&#x6001;&#xFF0C;&#x53EA;&#x8BFB;&#x3002;</p>
  248. </li>
  249. </ul>
  250. </li>
  251. <li><p><strong>getters</strong></p>
  252. <ul>
  253. <li><p>&#x7C7B;&#x578B;: <code>Object</code></p>
  254. <p>&#x66B4;&#x9732;&#x51FA;&#x6CE8;&#x518C;&#x7684; getter&#xFF0C;&#x53EA;&#x8BFB;&#x3002;</p>
  255. </li>
  256. </ul>
  257. </li>
  258. </ul>
  259. <h3 id="vuexstore-&#x5B9E;&#x4F8B;&#x65B9;&#x6CD5;">Vuex.Store &#x5B9E;&#x4F8B;&#x65B9;&#x6CD5;</h3>
  260. <ul>
  261. <li><strong><code>commit(type: string, payload?: any, options?: Object)</code></strong></li>
  262. <li><p><strong><code>commit(mutation: Object, options?: Object)</code></strong></p>
  263. <p>&#x63D0;&#x4EA4; mutation&#x3002;<code>options</code> &#x91CC;&#x53EF;&#x4EE5;&#x6709; <code>root: true</code>&#xFF0C;&#x5B83;&#x5141;&#x8BB8;&#x5728;<a href="modules.html#&#x547D;&#x540D;&#x7A7A;&#x95F4;">&#x547D;&#x540D;&#x7A7A;&#x95F4;&#x6A21;&#x5757;</a>&#x91CC;&#x63D0;&#x4EA4;&#x6839;&#x7684; mutation&#x3002;<a href="mutations.html">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  264. </li>
  265. <li><p><strong><code>dispatch(type: string, payload?: any, options?: Object)</code></strong></p>
  266. </li>
  267. <li><p><strong><code>dispatch(action: Object, options?: Object)</code></strong></p>
  268. <p>&#x5206;&#x53D1; action&#x3002;<code>options</code> &#x91CC;&#x53EF;&#x4EE5;&#x6709; <code>root: true</code>&#xFF0C;&#x5B83;&#x5141;&#x8BB8;&#x5728;<a href="modules.html#&#x547D;&#x540D;&#x7A7A;&#x95F4;">&#x547D;&#x540D;&#x7A7A;&#x95F4;&#x6A21;&#x5757;</a>&#x91CC;&#x5206;&#x53D1;&#x6839;&#x7684; action&#x3002;&#x8FD4;&#x56DE;&#x4E00;&#x4E2A;&#x89E3;&#x6790;&#x6240;&#x6709;&#x88AB;&#x89E6;&#x53D1;&#x7684; action &#x5904;&#x7406;&#x5668;&#x7684; Promise&#x3002;<a href="actions.html">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  269. </li>
  270. <li><p><strong><code>replaceState(state: Object)</code></strong></p>
  271. <p>&#x66FF;&#x6362; store &#x7684;&#x6839;&#x72B6;&#x6001;&#xFF0C;&#x4EC5;&#x7528;&#x72B6;&#x6001;&#x5408;&#x5E76;&#x6216;&#x65F6;&#x5149;&#x65C5;&#x884C;&#x8C03;&#x8BD5;&#x3002;</p>
  272. </li>
  273. <li><p><strong><code>watch(fn: Function, callback: Function, options?: Object): Function</code></strong></p>
  274. <p>&#x54CD;&#x5E94;&#x5F0F;&#x5730;&#x4FA6;&#x542C; <code>fn</code> &#x7684;&#x8FD4;&#x56DE;&#x503C;&#xFF0C;&#x5F53;&#x503C;&#x6539;&#x53D8;&#x65F6;&#x8C03;&#x7528;&#x56DE;&#x8C03;&#x51FD;&#x6570;&#x3002;<code>fn</code> &#x63A5;&#x6536; store &#x7684; state &#x4F5C;&#x4E3A;&#x7B2C;&#x4E00;&#x4E2A;&#x53C2;&#x6570;&#xFF0C;&#x5176; getter &#x4F5C;&#x4E3A;&#x7B2C;&#x4E8C;&#x4E2A;&#x53C2;&#x6570;&#x3002;&#x6700;&#x540E;&#x63A5;&#x6536;&#x4E00;&#x4E2A;&#x53EF;&#x9009;&#x7684;&#x5BF9;&#x8C61;&#x53C2;&#x6570;&#x8868;&#x793A; Vue &#x7684; <code>vm.$watch</code> &#x65B9;&#x6CD5;&#x7684;&#x53C2;&#x6570;&#x3002;</p>
  275. <p>&#x8981;&#x505C;&#x6B62;&#x4FA6;&#x542C;&#xFF0C;&#x8C03;&#x7528;&#x6B64;&#x65B9;&#x6CD5;&#x8FD4;&#x56DE;&#x7684;&#x51FD;&#x6570;&#x5373;&#x53EF;&#x505C;&#x6B62;&#x4FA6;&#x542C;&#x3002;</p>
  276. </li>
  277. <li><p><strong><code>subscribe(handler: Function): Function</code></strong></p>
  278. <p>&#x8BA2;&#x9605; store &#x7684; mutation&#x3002;<code>handler</code> &#x4F1A;&#x5728;&#x6BCF;&#x4E2A; mutation &#x5B8C;&#x6210;&#x540E;&#x8C03;&#x7528;&#xFF0C;&#x63A5;&#x6536; mutation &#x548C;&#x7ECF;&#x8FC7; mutation &#x540E;&#x7684;&#x72B6;&#x6001;&#x4F5C;&#x4E3A;&#x53C2;&#x6570;&#xFF1A;</p>
  279. <pre class="language-"><code class="lang-js">store<span class="token punctuation">.</span><span class="token function">subscribe</span><span class="token punctuation">(</span><span class="token punctuation">(</span>mutation<span class="token punctuation">,</span> state<span class="token punctuation">)</span> <span class="token operator">=</span><span class="token operator">&gt;</span> <span class="token punctuation">{</span>
  280. console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>mutation<span class="token punctuation">.</span>type<span class="token punctuation">)</span>
  281. console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>mutation<span class="token punctuation">.</span>payload<span class="token punctuation">)</span>
  282. <span class="token punctuation">}</span><span class="token punctuation">)</span>
  283. </code></pre>
  284. <p>&#x8981;&#x505C;&#x6B62;&#x8BA2;&#x9605;&#xFF0C;&#x8C03;&#x7528;&#x6B64;&#x65B9;&#x6CD5;&#x8FD4;&#x56DE;&#x7684;&#x51FD;&#x6570;&#x5373;&#x53EF;&#x505C;&#x6B62;&#x8BA2;&#x9605;&#x3002;</p>
  285. <p>&#x901A;&#x5E38;&#x7528;&#x4E8E;&#x63D2;&#x4EF6;&#x3002;<a href="plugins.html">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  286. </li>
  287. <li><p><strong><code>subscribeAction(handler: Function): Function</code></strong></p>
  288. <blockquote>
  289. <p>2.5.0 &#x65B0;&#x589E;</p>
  290. </blockquote>
  291. <p>&#x8BA2;&#x9605; store &#x7684; action&#x3002;<code>handler</code> &#x4F1A;&#x5728;&#x6BCF;&#x4E2A; action &#x5206;&#x53D1;&#x7684;&#x65F6;&#x5019;&#x8C03;&#x7528;&#x5E76;&#x63A5;&#x6536; action &#x63CF;&#x8FF0;&#x548C;&#x5F53;&#x524D;&#x7684; store &#x7684; state &#x8FD9;&#x4E24;&#x4E2A;&#x53C2;&#x6570;&#xFF1A;</p>
  292. <pre class="language-"><code class="lang-js">store<span class="token punctuation">.</span><span class="token function">subscribeAction</span><span class="token punctuation">(</span><span class="token punctuation">(</span>action<span class="token punctuation">,</span> state<span class="token punctuation">)</span> <span class="token operator">=</span><span class="token operator">&gt;</span> <span class="token punctuation">{</span>
  293. console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>action<span class="token punctuation">.</span>type<span class="token punctuation">)</span>
  294. console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>action<span class="token punctuation">.</span>payload<span class="token punctuation">)</span>
  295. <span class="token punctuation">}</span><span class="token punctuation">)</span>
  296. </code></pre>
  297. <p>&#x8981;&#x505C;&#x6B62;&#x8BA2;&#x9605;&#xFF0C;&#x8C03;&#x7528;&#x6B64;&#x65B9;&#x6CD5;&#x8FD4;&#x56DE;&#x7684;&#x51FD;&#x6570;&#x5373;&#x53EF;&#x505C;&#x6B62;&#x8BA2;&#x9605;&#x3002;</p>
  298. <p>&#x8BE5;&#x529F;&#x80FD;&#x5E38;&#x7528;&#x4E8E;&#x63D2;&#x4EF6;&#x3002;<a href="plugins.html">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  299. </li>
  300. <li><p><strong><code>registerModule(path: string | Array<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>string</span><span class="token punctuation">&gt;</span></span>, module: Module, options?: Object)</code></strong></p>
  301. <p>&#x6CE8;&#x518C;&#x4E00;&#x4E2A;&#x52A8;&#x6001;&#x6A21;&#x5757;&#x3002;<a href="modules.html#&#x6A21;&#x5757;&#x52A8;&#x6001;&#x6CE8;&#x518C;">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  302. <p><code>options</code> &#x53EF;&#x4EE5;&#x5305;&#x542B; <code>preserveState: true</code> &#x4EE5;&#x5141;&#x8BB8;&#x4FDD;&#x7559;&#x4E4B;&#x524D;&#x7684; state&#x3002;&#x7528;&#x4E8E;&#x670D;&#x52A1;&#x7AEF;&#x6E32;&#x67D3;&#x3002;</p>
  303. </li>
  304. <li><p><strong><code>unregisterModule(path: string | Array<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>string</span><span class="token punctuation">&gt;</span></span>)</code></strong></p>
  305. <p>&#x5378;&#x8F7D;&#x4E00;&#x4E2A;&#x52A8;&#x6001;&#x6A21;&#x5757;&#x3002;<a href="modules.html#&#x6A21;&#x5757;&#x52A8;&#x6001;&#x6CE8;&#x518C;">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  306. </li>
  307. <li><p><strong><code>hotUpdate(newOptions: Object)</code></strong></p>
  308. <p>&#x70ED;&#x66FF;&#x6362;&#x65B0;&#x7684; action &#x548C; mutation&#x3002;<a href="hot-reload.html">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  309. </li>
  310. </ul>
  311. <h3 id="&#x7EC4;&#x4EF6;&#x7ED1;&#x5B9A;&#x7684;&#x8F85;&#x52A9;&#x51FD;&#x6570;">&#x7EC4;&#x4EF6;&#x7ED1;&#x5B9A;&#x7684;&#x8F85;&#x52A9;&#x51FD;&#x6570;</h3>
  312. <ul>
  313. <li><p><strong><code>mapState(namespace?: string, map: Array<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>string</span><span class="token punctuation">&gt;</span></span> | Object): Object</code></strong></p>
  314. <p>&#x4E3A;&#x7EC4;&#x4EF6;&#x521B;&#x5EFA;&#x8BA1;&#x7B97;&#x5C5E;&#x6027;&#x4EE5;&#x8FD4;&#x56DE; Vuex store &#x4E2D;&#x7684;&#x72B6;&#x6001;&#x3002;<a href="state.html#mapstate-&#x8F85;&#x52A9;&#x51FD;&#x6570;">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  315. <p>&#x7B2C;&#x4E00;&#x4E2A;&#x53C2;&#x6570;&#x662F;&#x53EF;&#x9009;&#x7684;&#xFF0C;&#x53EF;&#x4EE5;&#x662F;&#x4E00;&#x4E2A;&#x547D;&#x540D;&#x7A7A;&#x95F4;&#x5B57;&#x7B26;&#x4E32;&#x3002;<a href="modules.html#&#x5E26;&#x547D;&#x540D;&#x7A7A;&#x95F4;&#x7684;&#x7ED1;&#x5B9A;&#x51FD;&#x6570;">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  316. </li>
  317. <li><p><strong><code>mapGetters(namespace?: string, map: Array<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>string</span><span class="token punctuation">&gt;</span></span> | Object): Object</code></strong></p>
  318. <p>&#x4E3A;&#x7EC4;&#x4EF6;&#x521B;&#x5EFA;&#x8BA1;&#x7B97;&#x5C5E;&#x6027;&#x4EE5;&#x8FD4;&#x56DE; getter &#x7684;&#x8FD4;&#x56DE;&#x503C;&#x3002;<a href="getters.html#mapgetters-&#x8F85;&#x52A9;&#x51FD;&#x6570;">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  319. <p>&#x7B2C;&#x4E00;&#x4E2A;&#x53C2;&#x6570;&#x662F;&#x53EF;&#x9009;&#x7684;&#xFF0C;&#x53EF;&#x4EE5;&#x662F;&#x4E00;&#x4E2A;&#x547D;&#x540D;&#x7A7A;&#x95F4;&#x5B57;&#x7B26;&#x4E32;&#x3002;<a href="modules.html#&#x5E26;&#x547D;&#x540D;&#x7A7A;&#x95F4;&#x7684;&#x7ED1;&#x5B9A;&#x51FD;&#x6570;">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  320. </li>
  321. <li><p><strong><code>mapActions(namespace?: string, map: Array<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>string</span><span class="token punctuation">&gt;</span></span> | Object): Object</code></strong></p>
  322. <p>&#x521B;&#x5EFA;&#x7EC4;&#x4EF6;&#x65B9;&#x6CD5;&#x5206;&#x53D1; action&#x3002;<a href="actions.html#&#x5728;&#x7EC4;&#x4EF6;&#x4E2D;&#x5206;&#x53D1;-action">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  323. <p>&#x7B2C;&#x4E00;&#x4E2A;&#x53C2;&#x6570;&#x662F;&#x53EF;&#x9009;&#x7684;&#xFF0C;&#x53EF;&#x4EE5;&#x662F;&#x4E00;&#x4E2A;&#x547D;&#x540D;&#x7A7A;&#x95F4;&#x5B57;&#x7B26;&#x4E32;&#x3002;<a href="modules.html#&#x5E26;&#x547D;&#x540D;&#x7A7A;&#x95F4;&#x7684;&#x7ED1;&#x5B9A;&#x51FD;&#x6570;">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  324. </li>
  325. <li><p><strong><code>mapMutations(namespace?: string, map: Array<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>string</span><span class="token punctuation">&gt;</span></span> | Object): Object</code></strong></p>
  326. <p>&#x521B;&#x5EFA;&#x7EC4;&#x4EF6;&#x65B9;&#x6CD5;&#x63D0;&#x4EA4; mutation&#x3002;<a href="mutations.html#&#x5728;&#x7EC4;&#x4EF6;&#x4E2D;&#x63D0;&#x4EA4;-mutation">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  327. <p>&#x7B2C;&#x4E00;&#x4E2A;&#x53C2;&#x6570;&#x662F;&#x53EF;&#x9009;&#x7684;&#xFF0C;&#x53EF;&#x4EE5;&#x662F;&#x4E00;&#x4E2A;&#x547D;&#x540D;&#x7A7A;&#x95F4;&#x5B57;&#x7B26;&#x4E32;&#x3002;<a href="modules.html#&#x5E26;&#x547D;&#x540D;&#x7A7A;&#x95F4;&#x7684;&#x7ED1;&#x5B9A;&#x51FD;&#x6570;">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  328. </li>
  329. <li><p><strong><code>createNamespacedHelpers(namespace: string): Object</code></strong></p>
  330. <p>&#x521B;&#x5EFA;&#x57FA;&#x4E8E;&#x547D;&#x540D;&#x7A7A;&#x95F4;&#x7684;&#x7EC4;&#x4EF6;&#x7ED1;&#x5B9A;&#x8F85;&#x52A9;&#x51FD;&#x6570;&#x3002;&#x5176;&#x8FD4;&#x56DE;&#x4E00;&#x4E2A;&#x5305;&#x542B; <code>mapState</code>&#x3001;<code>mapGetters</code>&#x3001;<code>mapActions</code> &#x548C; <code>mapMutations</code> &#x7684;&#x5BF9;&#x8C61;&#x3002;&#x5B83;&#x4EEC;&#x90FD;&#x5DF2;&#x7ECF;&#x7ED1;&#x5B9A;&#x5728;&#x4E86;&#x7ED9;&#x5B9A;&#x7684;&#x547D;&#x540D;&#x7A7A;&#x95F4;&#x4E0A;&#x3002;<a href="modules.html#&#x5E26;&#x547D;&#x540D;&#x7A7A;&#x95F4;&#x7684;&#x7ED1;&#x5B9A;&#x51FD;&#x6570;">&#x8BE6;&#x7EC6;&#x4ECB;&#x7ECD;</a></p>
  331. </li>
  332. </ul>
  333. </section>
  334. </div>
  335. <div class="search-results">
  336. <div class="has-results">
  337. <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
  338. <ul class="search-results-list"></ul>
  339. </div>
  340. <div class="no-results">
  341. <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
  342. </div>
  343. </div>
  344. </div>
  345. </div>
  346. </div>
  347. <script src="//m.servedby-buysellads.com/monetization.js" type="text/javascript"></script>
  348. <div class="bsa-cpc"></div>
  349. <script>
  350. (function(){
  351. if(typeof _bsa !== 'undefined' && _bsa) {
  352. _bsa.init('default', 'CKYD62QM', 'placement:vuejsorg', {
  353. target: '.bsa-cpc',
  354. align: 'horizontal',
  355. disable_css: 'true'
  356. });
  357. }
  358. })();
  359. </script>
  360. </div>
  361. <a href="hot-reload.html" class="navigation navigation-prev navigation-unique" aria-label="Previous page: 热重载">
  362. <i class="fa fa-angle-left"></i>
  363. </a>
  364. </div>
  365. <script>
  366. var gitbook = gitbook || [];
  367. gitbook.push(function() {
  368. 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":{"edit-link":{"label":"编辑此页面","base":"https://github.com/vuejs/vuex/tree/dev/docs"},"github":{"url":"https://github.com/vuejs/vuex/"},"prism":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":false,"twitter":false,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-vuejs":{},"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-04-20T00:44:03.889Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2018-04-20T00:47:55.633Z"},"basePath":".","book":{"language":"zh-cn"}});
  369. });
  370. </script>
  371. </div>
  372. <script src="../gitbook/gitbook.js"></script>
  373. <script src="../gitbook/theme.js"></script>
  374. <script src="../gitbook/gitbook-plugin-edit-link/plugin.js"></script>
  375. <script src="../gitbook/gitbook-plugin-github/plugin.js"></script>
  376. <script src="../gitbook/gitbook-plugin-search/search-engine.js"></script>
  377. <script src="../gitbook/gitbook-plugin-search/search.js"></script>
  378. <script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
  379. <script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
  380. <script src="../gitbook/gitbook-plugin-sharing/buttons.js"></script>
  381. </body>
  382. </html>