|
@@ -0,0 +1,392 @@
|
|
|
|
+---
|
|
|
|
+sidebar: auto
|
|
|
|
+---
|
|
|
|
+
|
|
|
|
+# API 参考
|
|
|
|
+
|
|
|
|
+## Store
|
|
|
|
+
|
|
|
|
+### createStore
|
|
|
|
+
|
|
|
|
+- `createStore<S>(options: StoreOptions<S>): Store<S>`
|
|
|
|
+
|
|
|
|
+ 创建一个 store 实例。
|
|
|
|
+
|
|
|
|
+ ```js
|
|
|
|
+ import { createStore } from 'vuex'
|
|
|
|
+
|
|
|
|
+ const store = createStore({ ...options })
|
|
|
|
+ ```
|
|
|
|
+
|
|
|
|
+## Store 构造器选项
|
|
|
|
+
|
|
|
|
+### state
|
|
|
|
+
|
|
|
|
+- 类型: `Object | Function`
|
|
|
|
+
|
|
|
|
+ Vuex store 实例的根 state 对象。[详细介绍](../guide/state.md)
|
|
|
|
+
|
|
|
|
+ 如果你传入返回一个对象的函数,其返回的对象会被用作根 state。这在你想要重用 state 对象,尤其是对于重用 module 来说非常有用。[详细介绍](../guide/modules.md#模块重用)
|
|
|
|
+
|
|
|
|
+### mutations
|
|
|
|
+
|
|
|
|
+- 类型: `{ [type: string]: Function }`
|
|
|
|
+
|
|
|
|
+ 在 store 上注册 mutation,处理函数总是接受 `state` 作为第一个参数(如果定义在模块中,则为模块的局部状态),`payload` 作为第二个参数(可选)。
|
|
|
|
+
|
|
|
|
+ [详细介绍](../guide/mutations.md)
|
|
|
|
+
|
|
|
|
+### actions
|
|
|
|
+
|
|
|
|
+- 类型: `{ [type: string]: Function }`
|
|
|
|
+
|
|
|
|
+ 在 store 上注册 action。处理函数总是接受 `context` 作为第一个参数,`payload` 作为第二个参数(可选)。
|
|
|
|
+
|
|
|
|
+ `context` 对象包含以下属性:
|
|
|
|
+
|
|
|
|
+ ``` js
|
|
|
|
+ {
|
|
|
|
+ state, // 等同于 `store.state`,若在模块中则为局部状态
|
|
|
|
+ rootState, // 等同于 `store.state`,只存在于模块中
|
|
|
|
+ commit, // 等同于 `store.commit`
|
|
|
|
+ dispatch, // 等同于 `store.dispatch`
|
|
|
|
+ getters, // 等同于 `store.getters`
|
|
|
|
+ rootGetters // 等同于 `store.getters`,只存在于模块中
|
|
|
|
+ }
|
|
|
|
+ ```
|
|
|
|
+
|
|
|
|
+ 同时如果有第二个参数 `payload` 的话也能够接收。
|
|
|
|
+
|
|
|
|
+ [详细介绍](../guide/actions.md)
|
|
|
|
+
|
|
|
|
+### getters
|
|
|
|
+
|
|
|
|
+- 类型: `{ [key: string]: Function }`
|
|
|
|
+
|
|
|
|
+在 store 上注册 getter,getter 方法接受以下参数:
|
|
|
|
+
|
|
|
|
+ ```
|
|
|
|
+ state, // 如果在模块中定义则为模块的局部状态
|
|
|
|
+ getters, // 等同于 store.getters
|
|
|
|
+ ```
|
|
|
|
+
|
|
|
|
+ 当定义在一个模块里时会特别一些:
|
|
|
|
+
|
|
|
|
+ ```
|
|
|
|
+ state, // 如果在模块中定义则为模块的局部状态
|
|
|
|
+ getters, // 等同于 store.getters
|
|
|
|
+ rootState // 等同于 store.state
|
|
|
|
+ rootGetters // 所有 getters
|
|
|
|
+ ```
|
|
|
|
+
|
|
|
|
+ 注册的 getter 暴露为 `store.getters`。
|
|
|
|
+
|
|
|
|
+ [详细介绍](../guide/getters.md)
|
|
|
|
+
|
|
|
|
+### modules
|
|
|
|
+
|
|
|
|
+- 类型: `Object`
|
|
|
|
+
|
|
|
|
+ 包含了子模块的对象,会被合并到 store,大概长这样:
|
|
|
|
+
|
|
|
|
+ ``` js
|
|
|
|
+ {
|
|
|
|
+ key: {
|
|
|
|
+ state,
|
|
|
|
+ namespaced?,
|
|
|
|
+ mutations,
|
|
|
|
+ actions?,
|
|
|
|
+ getters?,
|
|
|
|
+ modules?
|
|
|
|
+ },
|
|
|
|
+ ...
|
|
|
|
+ }
|
|
|
|
+ ```
|
|
|
|
+
|
|
|
|
+ 与根模块的选项一样,每个模块也包含 `state` 和 `mutations` 选项。模块的状态使用 key 关联到 store 的根状态。模块的 mutation 和 getter 只会接收 module 的局部状态作为第一个参数,而不是根状态,并且模块 action 的 `context.state` 同样指向局部状态。
|
|
|
|
+
|
|
|
|
+ [详细介绍](../guide/modules.md)
|
|
|
|
+
|
|
|
|
+### plugins
|
|
|
|
+
|
|
|
|
+- 类型: `Array<Function>`
|
|
|
|
+
|
|
|
|
+ 一个数组,包含应用在 store 上的插件方法。这些插件直接接收 store 作为唯一参数,可以监听 mutation(用于外部地数据持久化、记录或调试)或者提交 mutation (用于内部数据,例如 websocket 或 某些观察者)
|
|
|
|
+
|
|
|
|
+ [详细介绍](../guide/plugins.md)
|
|
|
|
+
|
|
|
|
+### strict
|
|
|
|
+
|
|
|
|
+- 类型: `boolean`
|
|
|
|
+- 默认值: `false`
|
|
|
|
+
|
|
|
|
+ 使 Vuex store 进入严格模式,在严格模式下,任何 mutation 处理函数以外修改 Vuex state 都会抛出错误。
|
|
|
|
+
|
|
|
|
+ [详细介绍](../guide/strict.md)
|
|
|
|
+
|
|
|
|
+### devtools
|
|
|
|
+
|
|
|
|
+- 类型:`boolean`
|
|
|
|
+
|
|
|
|
+ 为某个特定的 Vuex 实例打开或关闭 devtools。对于传入 `false` 的实例来说 Vuex store 不会订阅到 devtools 插件。对于一个页面中有多个 store 的情况非常有用。
|
|
|
|
+
|
|
|
|
+ ``` js
|
|
|
|
+ {
|
|
|
|
+ devtools: false
|
|
|
|
+ }
|
|
|
|
+ ```
|
|
|
|
+
|
|
|
|
+## Store 实例属性
|
|
|
|
+
|
|
|
|
+### state
|
|
|
|
+
|
|
|
|
+- 类型: `Object`
|
|
|
|
+
|
|
|
|
+ 根状态,只读。
|
|
|
|
+
|
|
|
|
+### getters
|
|
|
|
+
|
|
|
|
+- 类型: `Object`
|
|
|
|
+
|
|
|
|
+ 暴露出注册的 getter,只读。
|
|
|
|
+
|
|
|
|
+## Store 实例方法
|
|
|
|
+
|
|
|
|
+### commit
|
|
|
|
+
|
|
|
|
+- `commit(type: string, payload?: any, options?: Object)`
|
|
|
|
+- `commit(mutation: Object, options?: Object)`
|
|
|
|
+
|
|
|
|
+ 提交 mutation。`options` 里可以有 `root: true`,它允许在[命名空间模块](../guide/modules.md#命名空间)里提交根的 mutation。[详细介绍](../guide/mutations.md)
|
|
|
|
+
|
|
|
|
+### dispatch
|
|
|
|
+
|
|
|
|
+- `dispatch(type: string, payload?: any, options?: Object): Promise<any>`
|
|
|
|
+- `dispatch(action: Object, options?: Object): Promise<any>`
|
|
|
|
+
|
|
|
|
+ 分发 action。`options` 里可以有 `root: true`,它允许在[命名空间模块](../guide/modules.md#命名空间)里分发根的 action。返回一个解析所有被触发的 action 处理器的 Promise。[详细介绍](../guide/actions.md)
|
|
|
|
+
|
|
|
|
+### replaceState
|
|
|
|
+
|
|
|
|
+- `replaceState(state: Object)`
|
|
|
|
+
|
|
|
|
+ 替换 store 的根状态,仅用状态合并或时光旅行调试。
|
|
|
|
+
|
|
|
|
+### watch
|
|
|
|
+
|
|
|
|
+- `watch(fn: Function, callback: Function, options?: Object): Function`
|
|
|
|
+
|
|
|
|
+ 响应式地侦听 `fn` 的返回值,当值改变时调用回调函数。`fn` 接收 store 的 state 作为第一个参数,其 getter 作为第二个参数。最后接收一个可选的对象参数表示 Vue 的 [`vm.$watch`](https://cn.vuejs.org/v2/api/#vm-watch) 方法的参数。
|
|
|
|
+
|
|
|
|
+ 要停止侦听,调用此方法返回的函数即可停止侦听。
|
|
|
|
+
|
|
|
|
+### subscribe
|
|
|
|
+
|
|
|
|
+- `subscribe(handler: Function, options?: Object): Function`
|
|
|
|
+
|
|
|
|
+ 订阅 store 的 mutation。`handler` 会在每个 mutation 完成后调用,接收 mutation 和经过 mutation 后的状态作为参数:
|
|
|
|
+
|
|
|
|
+ ``` js
|
|
|
|
+ store.subscribe((mutation, state) => {
|
|
|
|
+ console.log(mutation.type)
|
|
|
|
+ console.log(mutation.payload)
|
|
|
|
+ })
|
|
|
|
+ ```
|
|
|
|
+
|
|
|
|
+ 默认情况下,新的处理函数会被添加到其链的尾端,因此它会在其它之前已经被添加了的处理函数之后执行。这一行为可以通过向 `options` 添加 `prepend: true` 来覆写,即把处理函数添加到其链的最开始。
|
|
|
|
+
|
|
|
|
+ ``` js
|
|
|
|
+ store.subscribe(handler, { prepend: true })
|
|
|
|
+ ```
|
|
|
|
+ 要停止订阅,调用此方法返回的函数即可停止订阅。
|
|
|
|
+
|
|
|
|
+ 通常用于插件。[详细介绍](../guide/plugins.md)
|
|
|
|
+
|
|
|
|
+### subscribeAction
|
|
|
|
+
|
|
|
|
+- `subscribeAction(handler: Function, options?: Object): Function`
|
|
|
|
+
|
|
|
|
+ 订阅 store 的 action。`handler` 会在每个 action 分发的时候调用并接收 action 描述和当前的 store 的 state 这两个参数:
|
|
|
|
+
|
|
|
|
+ ``` js
|
|
|
|
+ store.subscribeAction((action, state) => {
|
|
|
|
+ console.log(action.type)
|
|
|
|
+ console.log(action.payload)
|
|
|
|
+ })
|
|
|
|
+ ```
|
|
|
|
+
|
|
|
|
+ 默认情况下,新的处理函数会被添加到其链的尾端,因此它会在其它之前已经被添加了的处理函数之后执行。这一行为可以通过向 `options` 添加 `prepend: true` 来覆写,即把处理函数添加到其链的最开始。
|
|
|
|
+
|
|
|
|
+ ``` js
|
|
|
|
+ store.subscribeAction(handler, { prepend: true })
|
|
|
|
+ ```
|
|
|
|
+
|
|
|
|
+ 要停止订阅,调用此方法返回的函数即可停止订阅。
|
|
|
|
+
|
|
|
|
+ `subscribeAction` 也可以指定订阅处理函数的被调用时机应该在一个 action 分发*之前*还是*之后* (默认行为是*之前*):
|
|
|
|
+
|
|
|
|
+ ``` js
|
|
|
|
+ store.subscribeAction({
|
|
|
|
+ before: (action, state) => {
|
|
|
|
+ console.log(`before action ${action.type}`)
|
|
|
|
+ },
|
|
|
|
+ after: (action, state) => {
|
|
|
|
+ console.log(`after action ${action.type}`)
|
|
|
|
+ }
|
|
|
|
+ })
|
|
|
|
+ ```
|
|
|
|
+
|
|
|
|
+ `subscribeAction` 也可以指定一个 `error` 处理函数以捕获分发 action 的时候被抛出的错误。该函数会从第三个参数接收到一个 `error` 对象。
|
|
|
|
+
|
|
|
|
+ ``` js
|
|
|
|
+ store.subscribeAction({
|
|
|
|
+ error: (action, state, error) => {
|
|
|
|
+ console.log(`error action ${action.type}`)
|
|
|
|
+ console.error(error)
|
|
|
|
+ }
|
|
|
|
+ })
|
|
|
|
+ ```
|
|
|
|
+
|
|
|
|
+ 该 `subscribeAction` 方法常用于插件。[详细介绍](../guide/plugins.md)
|
|
|
|
+
|
|
|
|
+### registerModule
|
|
|
|
+
|
|
|
|
+- `registerModule(path: string | Array<string>, module: Module, options?: Object)`
|
|
|
|
+
|
|
|
|
+ 注册一个动态模块。[详细介绍](../guide/modules.md#模块动态注册)
|
|
|
|
+
|
|
|
|
+ `options` 可以包含 `preserveState: true` 以允许保留之前的 state。用于服务端渲染。
|
|
|
|
+
|
|
|
|
+### unregisterModule
|
|
|
|
+
|
|
|
|
+- `unregisterModule(path: string | Array<string>)`
|
|
|
|
+
|
|
|
|
+ 卸载一个动态模块。[详细介绍](../guide/modules.md#模块动态注册)
|
|
|
|
+
|
|
|
|
+### hasModule
|
|
|
|
+
|
|
|
|
+- `hasModule(path: string | Array<string>): boolean`
|
|
|
|
+
|
|
|
|
+ 检查该模块的名字是否已经被注册。[详细介绍](../guide/modules.md#模块动态注册)
|
|
|
|
+
|
|
|
|
+### hotUpdate
|
|
|
|
+
|
|
|
|
+- `hotUpdate(newOptions: Object)`
|
|
|
|
+
|
|
|
|
+ 热替换新的 action 和 mutation。[详细介绍](../guide/hot-reload.md)
|
|
|
|
+
|
|
|
|
+## 组件绑定的辅助函数
|
|
|
|
+
|
|
|
|
+### mapState
|
|
|
|
+
|
|
|
|
+- `mapState(namespace?: string, map: Array<string> | Object<string | function>): Object`
|
|
|
|
+
|
|
|
|
+ 为组件创建计算属性以返回 Vuex store 中的状态。[详细介绍](../guide/state.md#mapstate-辅助函数)
|
|
|
|
+
|
|
|
|
+ 第一个参数是可选的,可以是一个命名空间字符串。[详细介绍](../guide/modules.md#带命名空间的绑定函数)
|
|
|
|
+
|
|
|
|
+ 对象形式的第二个参数的成员可以是一个函数。`function(state: any)`
|
|
|
|
+
|
|
|
|
+### mapGetters
|
|
|
|
+
|
|
|
|
+- `mapGetters(namespace?: string, map: Array<string> | Object<string>): Object`
|
|
|
|
+
|
|
|
|
+ 为组件创建计算属性以返回 getter 的返回值。[详细介绍](../guide/getters.md#mapgetters-辅助函数)
|
|
|
|
+
|
|
|
|
+ 第一个参数是可选的,可以是一个命名空间字符串。[详细介绍](../guide/modules.md#带命名空间的绑定函数)
|
|
|
|
+
|
|
|
|
+### mapActions
|
|
|
|
+
|
|
|
|
+- `mapActions(namespace?: string, map: Array<string> | Object<string | function>): Object`
|
|
|
|
+
|
|
|
|
+ 创建组件方法分发 action。[详细介绍](../guide/actions.md#在组件中分发-action)
|
|
|
|
+
|
|
|
|
+ 第一个参数是可选的,可以是一个命名空间字符串。[详细介绍](../guide/modules.md#带命名空间的绑定函数)
|
|
|
|
+
|
|
|
|
+ 对象形式的第二个参数的成员可以是一个函数。`function(dispatch: function, ...args: any[])`
|
|
|
|
+
|
|
|
|
+### mapMutations
|
|
|
|
+
|
|
|
|
+- `mapMutations(namespace?: string, map: Array<string> | Object<string | function>): Object`
|
|
|
|
+
|
|
|
|
+ 创建组件方法提交 mutation。[详细介绍](../guide/mutations.md#在组件中提交-mutation)
|
|
|
|
+
|
|
|
|
+ 第一个参数是可选的,可以是一个命名空间字符串。[详细介绍](../guide/modules.md#带命名空间的绑定函数)
|
|
|
|
+
|
|
|
|
+ 对象形式的第二个参数的成员可以是一个函数。`function(commit: function, ...args: any[])`
|
|
|
|
+
|
|
|
|
+### createNamespacedHelpers
|
|
|
|
+
|
|
|
|
+- `createNamespacedHelpers(namespace: string): Object`
|
|
|
|
+
|
|
|
|
+ 创建基于命名空间的组件绑定辅助函数。其返回一个包含 `mapState`、`mapGetters`、`mapActions` 和 `mapMutations` 的对象。它们都已经绑定在了给定的命名空间上。[详细介绍](../guide/modules.md#带命名空间的绑定函数)
|
|
|
|
+
|
|
|
|
+## 组合式函数
|
|
|
|
+
|
|
|
|
+### useStore
|
|
|
|
+
|
|
|
|
+- `useStore<S = any>(injectKey?: InjectionKey<Store<S>> | string): Store<S>;`
|
|
|
|
+
|
|
|
|
+ 在 `setup` 钩子函数中调用该方法可以获取注入的 store。当使用组合式 API 时,可以通过调用该方法检索 store。
|
|
|
|
+
|
|
|
|
+ ```js
|
|
|
|
+ import { useStore } from 'vuex'
|
|
|
|
+
|
|
|
|
+ export default {
|
|
|
|
+ setup () {
|
|
|
|
+ const store = useStore()
|
|
|
|
+ }
|
|
|
|
+ }
|
|
|
|
+ ```
|
|
|
|
+
|
|
|
|
+ TypeScript 用户可以使用 injection key 来检索已经定义了类型的 store。为了使其工作,在将 store 实例安装到 Vue 应用中时,必须定义 injection key 并将其与 store 一起传递给 Vue 应用。
|
|
|
|
+
|
|
|
|
+ 首先,使用 Vue 的 `InjectionKey` 接口声明一个 injection key。
|
|
|
|
+
|
|
|
|
+ ```ts
|
|
|
|
+ // store.ts
|
|
|
|
+ import { InjectionKey } from 'vue'
|
|
|
|
+ import { createStore, Store } from 'vuex'
|
|
|
|
+
|
|
|
|
+ export interface State {
|
|
|
|
+ count: number
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ export const key: InjectionKey<Store<State>> = Symbol()
|
|
|
|
+
|
|
|
|
+ export const store = createStore<State>({
|
|
|
|
+ state: {
|
|
|
|
+ count: 0
|
|
|
|
+ }
|
|
|
|
+ })
|
|
|
|
+ ```
|
|
|
|
+
|
|
|
|
+ 然后,将定义好的 key 作为第二个参数传递给 `app.use` 方法。
|
|
|
|
+
|
|
|
|
+ ```ts
|
|
|
|
+ // main.ts
|
|
|
|
+ import { createApp } from 'vue'
|
|
|
|
+ import { store, key } from './store'
|
|
|
|
+
|
|
|
|
+ const app = createApp({ ... })
|
|
|
|
+
|
|
|
|
+ app.use(store, key)
|
|
|
|
+
|
|
|
|
+ app.mount('#app')
|
|
|
|
+ ```
|
|
|
|
+
|
|
|
|
+ 最后,将 key 传递给 `useStore` 方法以获取指定类型的 store 实例。
|
|
|
|
+
|
|
|
|
+ ```ts
|
|
|
|
+ // vue 组件
|
|
|
|
+ import { useStore } from 'vuex'
|
|
|
|
+ import { key } from './store'
|
|
|
|
+
|
|
|
|
+ export default {
|
|
|
|
+ setup () {
|
|
|
|
+ const store = useStore(key)
|
|
|
|
+
|
|
|
|
+ store.state.count // 类型为 number
|
|
|
|
+ }
|
|
|
|
+ }
|
|
|
|
+ ```
|