|
@@ -18,9 +18,9 @@ const store = new Vuex.Store({ ...options });
|
|
|
|
|
|
* тип: `Object | Function`
|
|
|
|
|
|
- Корневой объект состояния хранилища Vuex. [Подробнее](state.md)
|
|
|
+ Корневой объект состояния хранилища Vuex. [Подробнее](../guide/state.md)
|
|
|
|
|
|
- Если вы передаёте функцию, возвращающую объект, то возвращаемый объект будет использован в качестве корневого состояния. Это может быть полезным, если вы хотите повторно использовать объект состояния, особенно при повторном использовании модулей. [Подробнее](modules.md#повторное-использование-модулей)
|
|
|
+ Если вы передаёте функцию, возвращающую объект, то возвращаемый объект будет использован в качестве корневого состояния. Это может быть полезным, если вы хотите повторно использовать объект состояния, особенно при повторном использовании модулей. [Подробнее](../guide/modules.md#повторное-использование-модулей)
|
|
|
|
|
|
### mutations
|
|
|
|
|
@@ -28,7 +28,7 @@ const store = new Vuex.Store({ ...options });
|
|
|
|
|
|
Регистрирует доступные для хранилища мутации. Обработчики мутаций первым аргументом всегда получают `state` (при использовании модулей это будет локальный state модуля). Вторым аргументом передаётся "нагрузка" (`payload`), если она есть.
|
|
|
|
|
|
- [Подробнее](mutations.md)
|
|
|
+ [Подробнее](../guide/mutations.md)
|
|
|
|
|
|
### actions
|
|
|
|
|
@@ -38,18 +38,18 @@ const store = new Vuex.Store({ ...options });
|
|
|
|
|
|
```js
|
|
|
{
|
|
|
- state, // то же, что и `store.state`, или локальный state при использовании модулей
|
|
|
- rootState, // то же, что и `store.state`, только при использовании модулей
|
|
|
- commit, // то же, что и `store.commit`
|
|
|
- dispatch, // то же, что и `store.dispatch`
|
|
|
- getters, // то же, что и `store.getters`
|
|
|
- rootGetters; // то же, что и `store.getters`, только в модулях
|
|
|
+ state, // то же, что и `store.state`, или локальный state при использовании модулей
|
|
|
+ rootState, // то же, что и `store.state`, только при использовании модулей
|
|
|
+ commit, // то же, что и `store.commit`
|
|
|
+ dispatch, // то же, что и `store.dispatch`
|
|
|
+ getters, // то же, что и `store.getters`
|
|
|
+ rootGetters; // то же, что и `store.getters`, только в модулях
|
|
|
}
|
|
|
```
|
|
|
|
|
|
И также получает вторым аргументом `payload` если нагрузка была передана.
|
|
|
|
|
|
- [Подробнее](actions.md)
|
|
|
+ [Подробнее](../guide/actions.md)
|
|
|
|
|
|
### getters
|
|
|
|
|
@@ -73,7 +73,7 @@ const store = new Vuex.Store({ ...options });
|
|
|
|
|
|
Зарегистрированные геттеры далее доступны в `store.getters`.
|
|
|
|
|
|
- [Подробнее](getters.md)
|
|
|
+ [Подробнее](../guide/getters.md)
|
|
|
|
|
|
### modules
|
|
|
|
|
@@ -97,7 +97,7 @@ const store = new Vuex.Store({ ...options });
|
|
|
|
|
|
Каждый модуль может содержать `state` и `mutations`, как и корневое хранилище. Состояние модуля будет прикреплено к корневому, по указанному ключу. Мутации и геттеры модуля получают при вызове первым аргументом только локальное состояние, а не корневое. При вызове действий `context.state` аналогичным образом указывает на локальное состояние модуля.
|
|
|
|
|
|
- [Подробнее](modules.md)
|
|
|
+ [Подробнее](../guide/modules.md)
|
|
|
|
|
|
### plugins
|
|
|
|
|
@@ -105,7 +105,7 @@ const store = new Vuex.Store({ ...options });
|
|
|
|
|
|
Массив функций-плагинов, которые будут применены к хранилищу. Плагины попросту получают хранилище в качестве единственного аргумента, и могут как отслеживать мутации (для сохранения исходящих данных, логирования или отладки) или инициировать их (для обработки входящих данных, например, веб-сокетов или наблюдателей).
|
|
|
|
|
|
- [Подробнее](plugins.md)
|
|
|
+ [Подробнее](../guide/plugins.md)
|
|
|
|
|
|
### strict
|
|
|
|
|
@@ -114,7 +114,7 @@ const store = new Vuex.Store({ ...options });
|
|
|
|
|
|
Заставляет хранилище Vuex использовать strict mode. В strict mode любые изменения состояния, происходящие за пределами обработчиков мутаций, будут выбрасывать ошибки.
|
|
|
|
|
|
- [Подробнее](strict.md)
|
|
|
+ [Подробнее](../guide/strict.md)
|
|
|
|
|
|
## Свойства экземпляра Vuex.Store
|
|
|
|
|
@@ -137,14 +137,14 @@ const store = new Vuex.Store({ ...options });
|
|
|
* `commit(type: string, payload?: any, options?: Object)`
|
|
|
* `commit(mutation: Object, options?: Object)`
|
|
|
|
|
|
-Запускает мутацию. `options` может содержать опцию `root: true` что разрешает совершать корневые (root) мутации [в модулях со своим пространством имён](modules.md#пространства-имён). [Подробнее](mutations.md)
|
|
|
+Запускает мутацию. `options` может содержать опцию `root: true` что разрешает совершать корневые (root) мутации [в модулях со своим пространством имён](../guide/modules.md#пространства-имён). [Подробнее](../guide/mutations.md)
|
|
|
|
|
|
### dispatch
|
|
|
|
|
|
* `dispatch(type: string, payload?: any, options?: Object)`
|
|
|
* `dispatch(action: Object, options?: Object)`
|
|
|
|
|
|
-Инициирует действие. `options` может содержать опцию `root: true` что разрешает совершать корневые (root) действия [в модулях со своим пространством имён](modules.md#пространства-имён). Возвращает Promise который разрешает все обработчики инициируемых действий. [Подробнее](actions.md)
|
|
|
+Инициирует действие. `options` может содержать опцию `root: true` что разрешает совершать корневые (root) действия [в модулях со своим пространством имён](../guide/modules.md#пространства-имён). Возвращает Promise который разрешает все обработчики инициируемых действий. [Подробнее](../guide/actions.md)
|
|
|
|
|
|
### replaceState
|
|
|
|
|
@@ -175,7 +175,7 @@ store.subscribe((mutation, state) => {
|
|
|
|
|
|
Для остановки слежения необходимо вызвать возвращаемую функцию.
|
|
|
|
|
|
-Чаще всего используется в плагинах. [Подробнее](plugins.md)
|
|
|
+Чаще всего используется в плагинах. [Подробнее](../guide/plugins.md)
|
|
|
|
|
|
### subscribeAction
|
|
|
|
|
@@ -194,13 +194,13 @@ store.subscribeAction((action, state) => {
|
|
|
|
|
|
Для остановки слежения необходимо вызвать возвращаемую функцию.
|
|
|
|
|
|
-Чаще всего используется в плагинах. [Подробнее](plugins.md)
|
|
|
+Чаще всего используется в плагинах. [Подробнее](../guide/plugins.md)
|
|
|
|
|
|
### registerModule
|
|
|
|
|
|
* `registerModule(path: string | Array<string>, module: Module, options?: Object)`
|
|
|
|
|
|
-Регистрирует динамический модуль. [Подробнее](modules.md#динамическая-регистрация-модулей)
|
|
|
+Регистрирует динамический модуль. [Подробнее](../guide/modules.md#динамическая-регистрация-модулей)
|
|
|
|
|
|
`options` может иметь опцию `preserveState: true`, что позволяет сохранить предыдущее состояние. Полезно с рендерингом на стороне сервера.
|
|
|
|
|
@@ -208,13 +208,13 @@ store.subscribeAction((action, state) => {
|
|
|
|
|
|
* `unregisterModule(path: string | Array<string>)`
|
|
|
|
|
|
-Разрегистрирует динамический модуль. [Подробнее](modules.md#динамическая-регистрация-модулей)
|
|
|
+Разрегистрирует динамический модуль. [Подробнее](../guide/modules.md#динамическая-регистрация-модулей)
|
|
|
|
|
|
### hotUpdate
|
|
|
|
|
|
* `hotUpdate(newOptions: Object)`
|
|
|
|
|
|
-Осуществляет горячую замену действий и мутаций. [Подробнее](hot-reload.md)
|
|
|
+Осуществляет горячую замену действий и мутаций. [Подробнее](../guide/hot-reload.md)
|
|
|
|
|
|
## Вспомогательные функции для компонентов
|
|
|
|
|
@@ -222,9 +222,9 @@ store.subscribeAction((action, state) => {
|
|
|
|
|
|
* `mapState(namespace?: string, map: Array<string> | Object<string | function>): Object`
|
|
|
|
|
|
-Создаёт проксирующие вычисляемые свойства компонента, возвращающие поддерево state'а хранилища Vuex [Подробнее](state.md#вспомогательная-функция-mapstate)
|
|
|
+Создаёт проксирующие вычисляемые свойства компонента, возвращающие поддерево state'а хранилища Vuex [Подробнее](../guide/state.md#вспомогательная-функция-mapstate)
|
|
|
|
|
|
-Первый аргумент опционально может быть строкой с указанным namespace. [Подробнее](modules.md#подключение-с-помощью-вспомогательных-функций-к-пространству-имён)
|
|
|
+Первый аргумент опционально может быть строкой с указанным namespace. [Подробнее](../guide/modules.md#подключение-с-помощью-вспомогательных-функций-к-пространству-имён)
|
|
|
|
|
|
Второй аргумент вместо объекта может быть функцией. `function(state: any)`
|
|
|
|
|
@@ -232,17 +232,17 @@ store.subscribeAction((action, state) => {
|
|
|
|
|
|
* `mapGetters(namespace?: string, map: Array<string> | Object<string>): Object`
|
|
|
|
|
|
-Создаёт проксирующие вычисляемые свойства компонента, проксирующие доступ к геттерам. [Подробнее](getters.md#вспомогательная-функция-mapgetters)
|
|
|
+Создаёт проксирующие вычисляемые свойства компонента, проксирующие доступ к геттерам. [Подробнее](../guide/getters.md#вспомогательная-функция-mapgetters)
|
|
|
|
|
|
-Первый аргумент опционально может быть строкой с указанным namespace. [Подробнее](modules.md#подключение-с-помощью-вспомогательных-функций-к-пространству-имён)
|
|
|
+Первый аргумент опционально может быть строкой с указанным namespace. [Подробнее](../guide/modules.md#подключение-с-помощью-вспомогательных-функций-к-пространству-имён)
|
|
|
|
|
|
### mapActions
|
|
|
|
|
|
* `mapActions(namespace?: string, map: Array<string> | Object<string | function>): Object`
|
|
|
|
|
|
-Создаёт проксирующие методы компонента, позволяющие диспетчеризировать действия. [Подробнее](actions.md#диспетчеризация-действий-в-компонентах)
|
|
|
+Создаёт проксирующие методы компонента, позволяющие диспетчеризировать действия. [Подробнее](../guide/actions.md#диспетчеризация-действий-в-компонентах)
|
|
|
|
|
|
-Первый аргумент опционально может быть строкой с указанным namespace. [Подробнее](modules.md#подключение-с-помощью-вспомогательных-функций-к-пространству-имён)
|
|
|
+Первый аргумент опционально может быть строкой с указанным namespace. [Подробнее](../guide/modules.md#подключение-с-помощью-вспомогательных-функций-к-пространству-имён)
|
|
|
|
|
|
Второй аргумент вместо объекта может быть функцией. `function(dispatch: function, ...args: any[])`
|
|
|
|
|
@@ -250,9 +250,9 @@ store.subscribeAction((action, state) => {
|
|
|
|
|
|
* `mapMutations(namespace?: string, map: Array<string> | Object<string | function>): Object`
|
|
|
|
|
|
-Создаёт проксирующие методы компонента, позволяющие инициировать мутации. [Подробнее](mutations.md#вызов-мутаций-в-компонентах)
|
|
|
+Создаёт проксирующие методы компонента, позволяющие инициировать мутации. [Подробнее](../guide/mutations.md#вызов-мутаций-в-компонентах)
|
|
|
|
|
|
-Первый аргумент опционально может быть строкой с указанным namespace. [Подробнее](modules.md#подключение-с-помощью-вспомогательных-функций-к-пространству-имён)
|
|
|
+Первый аргумент опционально может быть строкой с указанным namespace. [Подробнее](../guide/modules.md#подключение-с-помощью-вспомогательных-функций-к-пространству-имён)
|
|
|
|
|
|
Второй аргумент вместо объекта может быть функцией. `function(commit: function, ...args: any[])`
|
|
|
|
|
@@ -260,4 +260,4 @@ store.subscribeAction((action, state) => {
|
|
|
|
|
|
* `createNamespacedHelpers(namespace: string): Object`
|
|
|
|
|
|
-Создаёт вспомогательные функции для связывания с компонентами для указанного пространства имён. Возвращаемый объект содержит `mapState`, `mapGetters`, `mapActions` и `mapMutations`, которые связаны с указанным пространством имён. [Подробнее](modules.md#подключение-с-помощью-вспомогательных-функций-к-пространству-имён)
|
|
|
+Создаёт вспомогательные функции для связывания с компонентами для указанного пространства имён. Возвращаемый объект содержит `mapState`, `mapGetters`, `mapActions` и `mapMutations`, которые связаны с указанным пространством имён. [Подробнее](../guide/modules.md#подключение-с-помощью-вспомогательных-функций-к-пространству-имён)
|