|
|
@@ -20,13 +20,13 @@ const store = new Vuex.Store({ ...options });
|
|
|
|
|
|
Корневой объект состояния хранилища Vuex. [Подробнее](../guide/state.md)
|
|
|
|
|
|
- Если вы передаёте функцию, возвращающую объект, то возвращаемый объект будет использован в качестве корневого состояния. Это может быть полезным, если вы хотите повторно использовать объект состояния, особенно при повторном использовании модулей. [Подробнее](../guide/modules.md#повторное-испоnьзование-модуnей)
|
|
|
+ При передаче функции, возвращающей объект, возвращаемый объект будет использован в качестве корневого состояния. Это пригодится, если необходимо повторно использовать объект состояния, особенно при повторном использовании модулей. [Подробнее](../guide/modules.md#повторное-испоnьзование-модуnей)
|
|
|
|
|
|
### mutations
|
|
|
|
|
|
* тип: `{ [type: string]: Function }`
|
|
|
|
|
|
- Регистрирует доступные для хранилища мутации. Обработчики мутаций первым аргументом всегда получают `state` (при использовании модулей это будет локальный state модуля). Вторым аргументом передаётся "нагрузка" (`payload`), если она есть.
|
|
|
+ Доступные мутации хранилища. Обработчики мутаций первым аргументом получают `state` (при использовании модулей это будет локальное состояние модуля). Вторым аргументом передаётся «нагрузка» (`payload`), если она есть.
|
|
|
|
|
|
[Подробнее](../guide/mutations.md)
|
|
|
|
|
|
@@ -34,7 +34,7 @@ const store = new Vuex.Store({ ...options });
|
|
|
|
|
|
* тип: `{ [type: string]: Function }`
|
|
|
|
|
|
- Регистрирует действия хранилища. В функции-обработчики передаётся объект `context`, со следующими свойствами:
|
|
|
+ Доступные действия хранилища. В обработчики передаётся объект `context`, со следующими свойствами:
|
|
|
|
|
|
```js
|
|
|
{
|
|
|
@@ -47,7 +47,7 @@ const store = new Vuex.Store({ ...options });
|
|
|
}
|
|
|
```
|
|
|
|
|
|
- И также получает вторым аргументом `payload` если нагрузка была передана.
|
|
|
+ Вторым аргументом передаётся «нагрузка» (`payload`), если она есть.
|
|
|
|
|
|
[Подробнее](../guide/actions.md)
|
|
|
|
|
|
@@ -55,7 +55,7 @@ const store = new Vuex.Store({ ...options });
|
|
|
|
|
|
* тип: `{ [key: string]: Function }`
|
|
|
|
|
|
- Регистрирует геттеры, используемые в хранилище. Геттер-функции при вызове получают следующие аргументы:
|
|
|
+ Доступные геттеры хранилища. Функция получает следующие аргументы:
|
|
|
|
|
|
```
|
|
|
state, // при использовании модулей — локальный state модуля
|
|
|
@@ -71,7 +71,7 @@ const store = new Vuex.Store({ ...options });
|
|
|
rootGetters // все геттеры
|
|
|
```
|
|
|
|
|
|
- Зарегистрированные геттеры далее доступны в `store.getters`.
|
|
|
+ Зарегистрированные геттеры доступны через `store.getters`.
|
|
|
|
|
|
[Подробнее](../guide/getters.md)
|
|
|
|
|
|
@@ -79,7 +79,7 @@ const store = new Vuex.Store({ ...options });
|
|
|
|
|
|
* тип: `Object`
|
|
|
|
|
|
- Объект, содержащий подмодули для помещения в хранилище, в формате:
|
|
|
+ Объект, содержащий под-модули для помещения в хранилище, в формате:
|
|
|
|
|
|
```js
|
|
|
{
|
|
|
@@ -95,7 +95,7 @@ const store = new Vuex.Store({ ...options });
|
|
|
}
|
|
|
```
|
|
|
|
|
|
- Каждый модуль может содержать `state` и `mutations`, как и корневое хранилище. Состояние модуля будет прикреплено к корневому, по указанному ключу. Мутации и геттеры модуля получают при вызове первым аргументом только локальное состояние, а не корневое. При вызове действий `context.state` аналогичным образом указывает на локальное состояние модуля.
|
|
|
+ У каждого модуля могут быть свои `state` и `mutations`, аналогично корневому хранилищу. Состояние модуля прикрепляется к корневому, по указанному ключу. Мутации и геттеры модуля получают первым аргументом локальное состояние, а не корневое. При вызове действий `context.state` аналогичным образом указывает на локальное состояние модуля.
|
|
|
|
|
|
[Подробнее](../guide/modules.md)
|
|
|
|
|
|
@@ -103,7 +103,7 @@ const store = new Vuex.Store({ ...options });
|
|
|
|
|
|
* тип: `Array<Function>`
|
|
|
|
|
|
- Массив функций-плагинов, которые будут применены к хранилищу. Плагины попросту получают хранилище в качестве единственного аргумента, и могут как отслеживать мутации (для сохранения исходящих данных, логирования или отладки) или инициировать их (для обработки входящих данных, например, веб-сокетов или наблюдателей).
|
|
|
+ Массив функций-плагинов, которые применяются к хранилищу. Плагины просто получают хранилище в качестве единственного аргумента, и могут как отслеживать мутации (для сохранения исходящих данных, логирования или отладки) или инициировать их (для обработки входящих данных, например, websockets или observables).
|
|
|
|
|
|
[Подробнее](../guide/plugins.md)
|
|
|
|
|
|
@@ -112,10 +112,22 @@ const store = new Vuex.Store({ ...options });
|
|
|
* тип: `Boolean`
|
|
|
* по умолчанию: `false`
|
|
|
|
|
|
- Заставляет хранилище Vuex использовать strict mode. В strict mode любые изменения состояния, происходящие за пределами обработчиков мутаций, будут выбрасывать ошибки.
|
|
|
+ Форсирует использование «строгого режима» в хранилище Vuex. В нём любые изменения состояния, происходящие вне обработчиков мутаций, будут выбрасывать ошибки.
|
|
|
|
|
|
[Подробнее](../guide/strict.md)
|
|
|
|
|
|
+### devtools
|
|
|
+
|
|
|
+* тип: `Boolean`
|
|
|
+
|
|
|
+ Интеграция в devtools конкретного экземпляра Vuex. Например, передача `false` сообщает экземпляру хранилища Vuex, что не требуется подписываться на плагин devtools. Это будет полезно если у вас несколько хранилищ на одной странице.
|
|
|
+
|
|
|
+ ``` js
|
|
|
+ {
|
|
|
+ devtools: false
|
|
|
+ }
|
|
|
+ ```
|
|
|
+
|
|
|
## Свойства экземпляра Vuex.Store
|
|
|
|
|
|
### state
|
|
|
@@ -137,34 +149,34 @@ const store = new Vuex.Store({ ...options });
|
|
|
* `commit(type: string, payload?: any, options?: Object)`
|
|
|
* `commit(mutation: Object, options?: Object)`
|
|
|
|
|
|
-Запускает мутацию. `options` может содержать опцию `root: true` что разрешает совершать корневые (root) мутации [в модулях со своим пространством имён](../guide/modules.md#пространства-имён). [Подробнее](../guide/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) действия [в модулях со своим пространством имён](../guide/modules.md#пространства-имён). Возвращает Promise который разрешает все обработчики инициируемых действий. [Подробнее](../guide/actions.md)
|
|
|
+Запуск действия. `options` может содержать опцию `root: true` что позволяет запускать корневые (root) действия [в модулях со своим пространством имён](../guide/modules.md#пространства-имён). Возвращает Promise который разрешает все обработчики инициируемых действий. [Подробнее](../guide/actions.md)
|
|
|
|
|
|
### replaceState
|
|
|
|
|
|
* `replaceState(state: Object)`
|
|
|
|
|
|
-Позволяет заменить корневое состояние хранилища. Используйте только для гидрации состояния / функциональности "машины времени".
|
|
|
+Замена корневого состояние хранилища новым. Используйте только для гидратации состояния и/или функциональности «машины времени».
|
|
|
|
|
|
### watch
|
|
|
|
|
|
* `watch(fn: Function, callback: Function, options?: Object): Function`
|
|
|
|
|
|
-Реактивно отслеживает возвращаемое значение `fn`, и вызывает коллбэк в случае изменений. `fn` получает состояние хранилища первым аргументом, и геттеры вторым аргументом. Принимает опциональный объект с настройками, с такими же параметрами как и у метода Vue `vm.$watch`.
|
|
|
+Реактивно отслеживает возвращаемое значение `fn`, и вызывает коллбэк в случае изменений. Первым аргументом `fn` будет состояние хранилища, вторым — геттеры. Опционально может принимать объект с настройками, с такими же параметрами как и у [метода Vue `vm.$watch`](https://ru.vuejs.org/v2/api/#vm-watch).
|
|
|
|
|
|
-Для прекращения наблюдения, необходимо вызвать возвращаемую функцию обработчик.
|
|
|
+Для прекращения отслеживания, необходимо вызвать возвращаемую методом функцию.
|
|
|
|
|
|
### subscribe
|
|
|
|
|
|
* `subscribe(handler: Function): Function`
|
|
|
|
|
|
-Подписывается на мутации хранилища. Обработчик `handler` вызывается после каждой мутации и получает в качестве параметров дескриптор мутации и состояние после мутации:
|
|
|
+Отслеживание вызова мутаций хранилища. Обработчик `handler` вызывается после каждой мутации и получает в качестве параметров дескриптор мутации и состояние после мутации:
|
|
|
|
|
|
```js
|
|
|
store.subscribe((mutation, state) => {
|
|
|
@@ -173,7 +185,7 @@ store.subscribe((mutation, state) => {
|
|
|
});
|
|
|
```
|
|
|
|
|
|
-Для остановки слежения необходимо вызвать возвращаемую функцию.
|
|
|
+Для прекращения отслеживания, необходимо вызвать возвращаемую методом функцию.
|
|
|
|
|
|
Чаще всего используется в плагинах. [Подробнее](../guide/plugins.md)
|
|
|
|
|
|
@@ -183,7 +195,7 @@ store.subscribe((mutation, state) => {
|
|
|
|
|
|
> Добавлено в версии 2.5.0
|
|
|
|
|
|
-Подписывается на действие хранилища. Обработчик `handler` вызывается после каждого действия и получает в качестве параметров дескриптов действия и текущее состояние хранилища:
|
|
|
+Отслеживание вызова действий хранилища. Обработчик `handler` вызывается после каждого действия и получает в качестве параметров дескриптор действия и текущее состояние хранилища:
|
|
|
|
|
|
```js
|
|
|
store.subscribeAction((action, state) => {
|
|
|
@@ -192,7 +204,7 @@ store.subscribeAction((action, state) => {
|
|
|
});
|
|
|
```
|
|
|
|
|
|
-Для остановки слежения необходимо вызвать возвращаемую функцию.
|
|
|
+Для прекращения отслеживания, необходимо вызвать возвращаемую методом функцию.
|
|
|
|
|
|
Чаще всего используется в плагинах. [Подробнее](../guide/plugins.md)
|
|
|
|
|
|
@@ -202,19 +214,19 @@ store.subscribeAction((action, state) => {
|
|
|
|
|
|
Регистрирует динамический модуль. [Подробнее](../guide/modules.md#динамическая-регистрация-модуnей)
|
|
|
|
|
|
-`options` может иметь опцию `preserveState: true`, что позволяет сохранить предыдущее состояние. Полезно с рендерингом на стороне сервера.
|
|
|
+`options` может иметь опцию `preserveState: true`, что позволяет сохранить предыдущее состояние. Полезно при отрисовке на стороне сервера (SSR).
|
|
|
|
|
|
### unregisterModule
|
|
|
|
|
|
* `unregisterModule(path: string | Array<string>)`
|
|
|
|
|
|
-Разрегистрирует динамический модуль. [Подробнее](../guide/modules.md#динамическая-регистрация-модуnей)
|
|
|
+Удаление зарегистрированного динамического модуля. [Подробнее](../guide/modules.md#динамическая-регистрация-модуnей)
|
|
|
|
|
|
### hotUpdate
|
|
|
|
|
|
* `hotUpdate(newOptions: Object)`
|
|
|
|
|
|
-Осуществляет горячую замену действий и мутаций. [Подробнее](../guide/hot-reload.md)
|
|
|
+Горячая перезагрузка действий и мутаций. [Подробнее](../guide/hot-reload.md)
|
|
|
|
|
|
## Вспомогательные функции для компонентов
|
|
|
|
|
|
@@ -222,9 +234,9 @@ store.subscribeAction((action, state) => {
|
|
|
|
|
|
* `mapState(namespace?: string, map: Array<string> | Object<string | function>): Object`
|
|
|
|
|
|
-Создаёт проксирующие вычисляемые свойства компонента, возвращающие поддерево state'а хранилища Vuex [Подробнее](../guide/state.md#вспомогатеnьная-функция-mapstate)
|
|
|
+Создаёт вычисляемые свойства компонента, возвращающие под-дерево состояния хранилища Vuex. [Подробнее](../guide/state.md#вспомогатеnьная-функция-mapstate)
|
|
|
|
|
|
-Первый аргумент опционально может быть строкой с указанным namespace. [Подробнее](../guide/modules.md#подкnючение-с-помощью-вспомогатеnьных-функций-к-пространству-имён)
|
|
|
+Первый опциональный аргумент может быть строкой пространства имён. [Подробнее](../guide/modules.md#подкnючение-с-помощью-вспомогатеnьных-функций-к-пространству-имён)
|
|
|
|
|
|
Второй аргумент вместо объекта может быть функцией. `function(state: any)`
|
|
|
|
|
|
@@ -232,17 +244,17 @@ store.subscribeAction((action, state) => {
|
|
|
|
|
|
* `mapGetters(namespace?: string, map: Array<string> | Object<string>): Object`
|
|
|
|
|
|
-Создаёт проксирующие вычисляемые свойства компонента, проксирующие доступ к геттерам. [Подробнее](../guide/getters.md#вспомогатеnьная-функция-mapgetters)
|
|
|
+Создаёт вычисляемые свойства компонента для доступа к геттерам. [Подробнее](../guide/getters.md#вспомогатеnьная-функция-mapgetters)
|
|
|
|
|
|
-Первый аргумент опционально может быть строкой с указанным namespace. [Подробнее](../guide/modules.md#подкnючение-с-помощью-вспомогатеnьных-функций-к-пространству-имён)
|
|
|
+Первый опциональный аргумент может быть строкой пространства имён. [Подробнее](../guide/modules.md#подкnючение-с-помощью-вспомогатеnьных-функций-к-пространству-имён)
|
|
|
|
|
|
### mapActions
|
|
|
|
|
|
* `mapActions(namespace?: string, map: Array<string> | Object<string | function>): Object`
|
|
|
|
|
|
-Создаёт проксирующие методы компонента, позволяющие диспетчеризировать действия. [Подробнее](../guide/actions.md#диспетчеризация-действий-в-компонентах)
|
|
|
+Создаёт проксирующие методы компонента для вызова действий хранилища. [Подробнее](../guide/actions.md#диспетчеризация-действий-в-компонентах)
|
|
|
|
|
|
-Первый аргумент опционально может быть строкой с указанным namespace. [Подробнее](../guide/modules.md#подкnючение-с-помощью-вспомогатеnьных-функций-к-пространству-имён)
|
|
|
+Первый опциональный аргумент может быть строкой пространства имён. [Подробнее](../guide/modules.md#подкnючение-с-помощью-вспомогатеnьных-функций-к-пространству-имён)
|
|
|
|
|
|
Второй аргумент вместо объекта может быть функцией. `function(dispatch: function, ...args: any[])`
|
|
|
|
|
|
@@ -250,9 +262,9 @@ store.subscribeAction((action, state) => {
|
|
|
|
|
|
* `mapMutations(namespace?: string, map: Array<string> | Object<string | function>): Object`
|
|
|
|
|
|
-Создаёт проксирующие методы компонента, позволяющие инициировать мутации. [Подробнее](../guide/mutations.md#вызов-мутаций-в-компонентах)
|
|
|
+Создаёт проксирующие методы компонента для вызова мутаций хранилища. [Подробнее](../guide/mutations.md#вызов-мутаций-в-компонентах)
|
|
|
|
|
|
-Первый аргумент опционально может быть строкой с указанным namespace. [Подробнее](../guide/modules.md#подкnючение-с-помощью-вспомогатеnьных-функций-к-пространству-имён)
|
|
|
+Первый опциональный аргумент может быть строкой пространства имён. [Подробнее](../guide/modules.md#подкnючение-с-помощью-вспомогатеnьных-функций-к-пространству-имён)
|
|
|
|
|
|
Второй аргумент вместо объекта может быть функцией. `function(commit: function, ...args: any[])`
|
|
|
|
|
|
@@ -260,4 +272,4 @@ store.subscribeAction((action, state) => {
|
|
|
|
|
|
* `createNamespacedHelpers(namespace: string): Object`
|
|
|
|
|
|
-Создаёт вспомогательные функции для связывания с компонентами для указанного пространства имён. Возвращаемый объект содержит `mapState`, `mapGetters`, `mapActions` и `mapMutations`, которые связаны с указанным пространством имён. [Подробнее](../guide/modules.md#подкnючение-с-помощью-вспомогатеnьных-функций-к-пространству-имён)
|
|
|
+Создаёт вспомогательные функции связывания с компонентами для указанного пространства имён. Возвращаемый объект содержит `mapState`, `mapGetters`, `mapActions` и `mapMutations`, которые связаны с указанным пространством имён. [Подробнее](../guide/modules.md#подкnючение-с-помощью-вспомогатеnьных-функций-к-пространству-имён)
|
Alexander Sokolov