Skip to content

Commit

Permalink
docs: add missing return types
Browse files Browse the repository at this point in the history
  • Loading branch information
humilitypatience committed Apr 23, 2020
1 parent 2fefed5 commit 2238b36
Show file tree
Hide file tree
Showing 7 changed files with 29 additions and 31 deletions.
11 changes: 5 additions & 6 deletions docs/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ const store = new Vuex.Store({ ...options })
### strict
- type: `Boolean`
- type: `boolean`
- default: `false`
Force the Vuex store into strict mode. In strict mode any mutations to Vuex state outside of mutation handlers will throw an Error.
Expand All @@ -118,7 +118,7 @@ const store = new Vuex.Store({ ...options })
### devtools
- type: `Boolean`
- type: `boolean`
Turn the devtools on or off for a particular vuex instance. For instance passing false tells the Vuex store to not subscribe to devtools plugin. Useful for if you have multiple stores on a single page.
Expand All @@ -128,7 +128,6 @@ const store = new Vuex.Store({ ...options })
}
```
## Vuex.Store Instance Properties
### state
Expand All @@ -154,8 +153,8 @@ const store = new Vuex.Store({ ...options })
### dispatch
- `dispatch(type: string, payload?: any, options?: Object)`
- `dispatch(action: Object, options?: Object)`
- `dispatch(type: string, payload?: any, options?: Object): Promise<any>`
- `dispatch(action: Object, options?: Object): Promise<any>`
Dispatch an action. `options` can have `root: true` that allows to dispatch root actions in [namespaced modules](../guide/modules.md#namespacing). Returns a Promise that resolves all triggered action handlers. [Details](../guide/actions.md)
Expand Down Expand Up @@ -240,7 +239,7 @@ const store = new Vuex.Store({ ...options })
### hasModule
- `hasModule(path: string | Array<string>)`
- `hasModule(path: string | Array<string>): boolean`
Check if the module with the given name is already registered. [Details](../guide/modules.md#dynamic-module-registration)
Expand Down
6 changes: 3 additions & 3 deletions docs/fr/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ const store = new Vuex.Store({ ...options })
### strict
- type : `Boolean`
- type : `boolean`
- default: `false`
Force le store Vuex en mode strict. En mode strict, toute mutation de l'état en dehors des gestionnaires de mutation lancera une erreur.
Expand Down Expand Up @@ -139,8 +139,8 @@ const store = new Vuex.Store({ ...options })

### dispatch

- `dispatch(type: string, payload?: any, options?: Object)`
- `dispatch(action: Object, options?: Object)`
- `dispatch(type: string, payload?: any, options?: Object): Promise<any>`
- `dispatch(action: Object, options?: Object): Promise<any>`

Propager une action. Retourne la valeur renvoyée par le gestionnaire d'action déclenché, ou une Promesse si plusieurs gestionnaires ont été déclenchés. [Plus de détails](../guide/actions.md)
Expand Down
6 changes: 3 additions & 3 deletions docs/ja/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,8 @@ const store = new Vuex.Store({ ...options })

### dispatch

- **`dispatch(type: string, payload?: any, options?: Object)`**
- **`dispatch(action: Object, options?: Object)`**
- **`dispatch(type: string, payload?: any, options?: Object): Promise<any>`**
- **`dispatch(action: Object, options?: Object): Promise<any>`**

アクションをディスパッチします。`options` は[名前空間付きモジュール](../guide/modules.md#名前空間)で root なアクションにディスパッチできる `root: true` を持つことできます。 すべてのトリガーされたアクションハンドラを解決するPromiseを返します。[詳細](../guide/actions.md)

Expand Down Expand Up @@ -240,7 +240,7 @@ const store = new Vuex.Store({ ...options })

### hasModule

- `hasModule(path: string | Array<string>)`
- `hasModule(path: string | Array<string>): boolean`

動的なモジュールがすでに登録されているかどうかを確認します。[詳細](../guide/modules.md#dynamic-module-registration)

Expand Down
6 changes: 3 additions & 3 deletions docs/kr/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ const store = new Vuex.Store({ ...options })

### strict

- 자료형: `Boolean`
- 자료형: `boolean`
- 기본값: `false`

Vuex 저장소를 strict 모드로 변경합니다. strict 모드에서 변이 핸들러 외부의 Vuex 상태에 대한 임의의 변이는 오류를 발생시킵니다.
Expand Down Expand Up @@ -141,8 +141,8 @@ const store = new Vuex.Store({ ...options })

### dispatch

- `dispatch(type: string, payload?: any, options?: Object)`
- `dispatch(action: Object, options?: Object)`
- `dispatch(type: string, payload?: any, options?: Object): Promise<any>`
- `dispatch(action: Object, options?: Object): Promise<any>`

액션을 디스패치 합니다. `options``root:true` 를 포함하면 [네임스페이스 모듈](../guide/modules.md#네임스페이스) 의 root 액션에 디스패치를 허용합니다. 모든 트리거된 액션 핸들러를 처리하는 Promise를 반환합니다. [상세](../guide/actions.md)

Expand Down
9 changes: 4 additions & 5 deletions docs/ptbr/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ const store = new Vuex.Store({ ...options })
### strict
- type: `Boolean`
- type: `boolean`
- default: `false`
Força o _store_ Vuex em modo estrito. No modo estrito, qualquer mutação ao estado do Vuex fora dos manipuladores de mutação acusará um erro.
Expand All @@ -118,7 +118,7 @@ const store = new Vuex.Store({ ...options })
### devtools
- type: `Boolean`
- type: `boolean`
Ative ou desative as ferramentas de desenvolvedor para uma determinada instância vuex. Passar _false_ à instância diz ao _store_ Vuex para não se integrar ao _devtools_. Útil para quando se tem vários _stores_ em uma _single page_.
Expand All @@ -128,7 +128,6 @@ const store = new Vuex.Store({ ...options })
}
```
## Vuex.Store Propriedades da Instância
### state
Expand All @@ -154,8 +153,8 @@ const store = new Vuex.Store({ ...options })
### dispatch
- `dispatch(type: string, payload?: any, options?: Object)`
- `dispatch(action: Object, options?: Object)`
- `dispatch(type: string, payload?: any, options?: Object): Promise<any>`
- `dispatch(action: Object, options?: Object): Promise<any>`
Despacha uma ação. _options_ pode ter _root: true_ que permite despachar ações para raiz em [módulos namespaced](../guide/modules.md#namespacing). Retorna um _Promise_ que resolve todos os manipuladores de ação acionados. [Detalhes](../guide/actions.md)
Expand Down
12 changes: 6 additions & 6 deletions docs/ru/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ const store = new Vuex.Store({ ...options });
### strict
* тип: `Boolean`
* тип: `boolean`
* по умолчанию: `false`
Форсирует использование «строгого режима» в хранилище Vuex. В нём любые изменения состояния, происходящие вне обработчиков мутаций, будут выбрасывать ошибки.
Expand All @@ -118,10 +118,10 @@ const store = new Vuex.Store({ ...options });
### devtools
* тип: `Boolean`
* тип: `boolean`
Интеграция в devtools конкретного экземпляра Vuex. Например, передача `false` сообщает экземпляру хранилища Vuex, что не требуется подписываться на плагин devtools. Это будет полезно если у вас несколько хранилищ на одной странице.
```js
{
devtools: false
Expand Down Expand Up @@ -153,8 +153,8 @@ const store = new Vuex.Store({ ...options });
### dispatch
* `dispatch(type: string, payload?: any, options?: Object)`
* `dispatch(action: Object, options?: Object)`
* `dispatch(type: string, payload?: any, options?: Object): Promise<any>`
* `dispatch(action: Object, options?: Object): Promise<any>`
Запуск действия. `options` может содержать опцию `root: true` что позволяет запускать корневые (root) действия [в модулях со своим пространством имён](../guide/modules.md#пространства-имён). Возвращает Promise который разрешает все обработчики инициируемых действий. [Подробнее](../guide/actions.md)
Expand Down Expand Up @@ -239,7 +239,7 @@ store.subscribeAction({
### hasModule
* `hasModule(path: string | Array<string>)`
* `hasModule(path: string | Array<string>): boolean`
Проверка, не зарегистрирован ли уже модуль с заданным именем. [Подробнее](../guide/modules.md#динамическая-регистрация-модуnей)
Expand Down
10 changes: 5 additions & 5 deletions docs/zh/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ const store = new Vuex.Store({ ...options })
### strict
- 类型: `Boolean`
- 类型: `boolean`
- 默认值: `false`
使 Vuex store 进入严格模式,在严格模式下,任何 mutation 处理函数以外修改 Vuex state 都会抛出错误。
Expand All @@ -120,7 +120,7 @@ const store = new Vuex.Store({ ...options })
### devtools
- 类型:`Boolean`
- 类型:`boolean`
为某个特定的 Vuex 实例打开或关闭 devtools。对于传入 `false` 的实例来说 Vuex store 不会订阅到 devtools 插件。可用于一个页面中有多个 store 的情况。
Expand Down Expand Up @@ -155,8 +155,8 @@ const store = new Vuex.Store({ ...options })
### dispatch
- `dispatch(type: string, payload?: any, options?: Object)`
- `dispatch(action: Object, options?: Object)`
- `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)
Expand Down Expand Up @@ -241,7 +241,7 @@ const store = new Vuex.Store({ ...options })
### hasModule
- `hasModule(path: string | Array<string>)`
- `hasModule(path: string | Array<string>): boolean`
检查该模块的名字是否已经被注册。[详细介绍](../guide/modules.md#模块动态注册)
Expand Down

0 comments on commit 2238b36

Please sign in to comment.