Browse Source

docs: add missing return types

Kia Ishii 5 years ago
parent
commit
19e6337996

+ 5 - 6
docs/api/README.md

@@ -109,7 +109,7 @@ const store = new Vuex.Store({ ...options })
 
 
 ### strict
 ### strict
 
 
-- type: `Boolean`
+- type: `boolean`
 - default: `false`
 - 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.
   Force the Vuex store into strict mode. In strict mode any mutations to Vuex state outside of mutation handlers will throw an Error.
@@ -118,7 +118,7 @@ const store = new Vuex.Store({ ...options })
 
 
 ### devtools
 ### 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.
   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.
 
 
@@ -128,7 +128,6 @@ const store = new Vuex.Store({ ...options })
   }
   }
   ```
   ```
 
 
-
 ## Vuex.Store Instance Properties
 ## Vuex.Store Instance Properties
 
 
 ### state
 ### state
@@ -154,8 +153,8 @@ const store = new Vuex.Store({ ...options })
 
 
 ### dispatch
 ### 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)
   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)
 
 
@@ -240,7 +239,7 @@ const store = new Vuex.Store({ ...options })
 
 
 ### hasModule
 ### 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)
   Check if the module with the given name is already registered. [Details](../guide/modules.md#dynamic-module-registration)
 
 

+ 3 - 3
docs/fr/api/README.md

@@ -107,7 +107,7 @@ const store = new Vuex.Store({ ...options })
 
 
 ### strict
 ### strict
 
 
-  - type : `Boolean`
+  - type : `boolean`
   - default: `false`
   - 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.
     Force le store Vuex en mode strict. En mode strict, toute mutation de l'état en dehors des gestionnaires de mutation lancera une erreur.
@@ -139,8 +139,8 @@ const store = new Vuex.Store({ ...options })
 
 
 ### dispatch
 ### 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)
   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)
 
 

+ 3 - 3
docs/ja/api/README.md

@@ -154,8 +154,8 @@ const store = new Vuex.Store({ ...options })
 
 
 ### dispatch
 ### 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)
   アクションをディスパッチします。`options` は[名前空間付きモジュール](../guide/modules.md#名前空間)で root なアクションにディスパッチできる `root: true` を持つことできます。 すべてのトリガーされたアクションハンドラを解決するPromiseを返します。[詳細](../guide/actions.md)
 
 
@@ -240,7 +240,7 @@ const store = new Vuex.Store({ ...options })
 
 
 ### hasModule
 ### hasModule
 
 
-- `hasModule(path: string | Array<string>)`
+- `hasModule(path: string | Array<string>): boolean`
 
 
   動的なモジュールがすでに登録されているかどうかを確認します。[詳細](../guide/modules.md#dynamic-module-registration)
   動的なモジュールがすでに登録されているかどうかを確認します。[詳細](../guide/modules.md#dynamic-module-registration)
 
 

+ 3 - 3
docs/kr/api/README.md

@@ -109,7 +109,7 @@ const store = new Vuex.Store({ ...options })
 
 
 ### strict
 ### strict
 
 
-- 자료형: `Boolean`
+- 자료형: `boolean`
 - 기본값: `false`
 - 기본값: `false`
 
 
   Vuex 저장소를 strict 모드로 변경합니다. strict 모드에서 변이 핸들러 외부의 Vuex 상태에 대한 임의의 변이는 오류를 발생시킵니다.
   Vuex 저장소를 strict 모드로 변경합니다. strict 모드에서 변이 핸들러 외부의 Vuex 상태에 대한 임의의 변이는 오류를 발생시킵니다.
@@ -141,8 +141,8 @@ const store = new Vuex.Store({ ...options })
 
 
 ### dispatch
 ### 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)
   액션을 디스패치 합니다. `options` 에 `root:true` 를 포함하면 [네임스페이스 모듈](../guide/modules.md#네임스페이스) 의 root 액션에 디스패치를 허용합니다. 모든 트리거된 액션 핸들러를 처리하는 Promise를 반환합니다. [상세](../guide/actions.md)
 
 

+ 4 - 5
docs/ptbr/api/README.md

@@ -109,7 +109,7 @@ const store = new Vuex.Store({ ...options })
 
 
 ### strict
 ### strict
 
 
-- type: `Boolean`
+- type: `boolean`
 - default: `false`
 - 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.
   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.
@@ -118,7 +118,7 @@ const store = new Vuex.Store({ ...options })
 
 
 ### devtools
 ### 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_.
   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_.
 
 
@@ -128,7 +128,6 @@ const store = new Vuex.Store({ ...options })
   }
   }
   ```
   ```
 
 
-
 ## Vuex.Store Propriedades da Instância
 ## Vuex.Store Propriedades da Instância
 
 
 ### state
 ### state
@@ -154,8 +153,8 @@ const store = new Vuex.Store({ ...options })
 
 
 ### dispatch
 ### 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)
   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)
 
 

+ 6 - 6
docs/ru/api/README.md

@@ -109,7 +109,7 @@ const store = new Vuex.Store({ ...options });
 
 
 ### strict
 ### strict
 
 
-* тип: `Boolean`
+* тип: `boolean`
 * по умолчанию: `false`
 * по умолчанию: `false`
 
 
   Форсирует использование «строгого режима» в хранилище Vuex. В нём любые изменения состояния, происходящие вне обработчиков мутаций, будут выбрасывать ошибки.
   Форсирует использование «строгого режима» в хранилище Vuex. В нём любые изменения состояния, происходящие вне обработчиков мутаций, будут выбрасывать ошибки.
@@ -118,10 +118,10 @@ const store = new Vuex.Store({ ...options });
 
 
 ### devtools
 ### devtools
 
 
-* тип: `Boolean`
+* тип: `boolean`
 
 
   Интеграция в devtools конкретного экземпляра Vuex. Например, передача `false` сообщает экземпляру хранилища Vuex, что не требуется подписываться на плагин devtools. Это будет полезно если у вас несколько хранилищ на одной странице.
   Интеграция в devtools конкретного экземпляра Vuex. Например, передача `false` сообщает экземпляру хранилища Vuex, что не требуется подписываться на плагин devtools. Это будет полезно если у вас несколько хранилищ на одной странице.
-  
+
   ```js
   ```js
   {
   {
     devtools: false
     devtools: false
@@ -153,8 +153,8 @@ const store = new Vuex.Store({ ...options });
 
 
 ### dispatch
 ### 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)
 Запуск действия. `options` может содержать опцию `root: true` что позволяет запускать корневые (root) действия [в модулях со своим пространством имён](../guide/modules.md#пространства-имён). Возвращает Promise который разрешает все обработчики инициируемых действий. [Подробнее](../guide/actions.md)
 
 
@@ -239,7 +239,7 @@ store.subscribeAction({
 
 
 ### hasModule
 ### hasModule
 
 
-* `hasModule(path: string | Array<string>)`
+* `hasModule(path: string | Array<string>): boolean`
 
 
 Проверка, не зарегистрирован ли уже модуль с заданным именем. [Подробнее](../guide/modules.md#динамическая-регистрация-модуnей)
 Проверка, не зарегистрирован ли уже модуль с заданным именем. [Подробнее](../guide/modules.md#динамическая-регистрация-модуnей)
 
 

+ 5 - 5
docs/zh/api/README.md

@@ -111,7 +111,7 @@ const store = new Vuex.Store({ ...options })
 
 
 ### strict
 ### strict
 
 
-- 类型: `Boolean`
+- 类型: `boolean`
 - 默认值: `false`
 - 默认值: `false`
 
 
   使 Vuex store 进入严格模式,在严格模式下,任何 mutation 处理函数以外修改 Vuex state 都会抛出错误。
   使 Vuex store 进入严格模式,在严格模式下,任何 mutation 处理函数以外修改 Vuex state 都会抛出错误。
@@ -120,7 +120,7 @@ const store = new Vuex.Store({ ...options })
 
 
 ### devtools
 ### devtools
 
 
-- 类型:`Boolean`
+- 类型:`boolean`
 
 
   为某个特定的 Vuex 实例打开或关闭 devtools。对于传入 `false` 的实例来说 Vuex store 不会订阅到 devtools 插件。可用于一个页面中有多个 store 的情况。
   为某个特定的 Vuex 实例打开或关闭 devtools。对于传入 `false` 的实例来说 Vuex store 不会订阅到 devtools 插件。可用于一个页面中有多个 store 的情况。
 
 
@@ -155,8 +155,8 @@ const store = new Vuex.Store({ ...options })
 
 
 ### dispatch
 ### 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)
   分发 action。`options` 里可以有 `root: true`,它允许在[命名空间模块](../guide/modules.md#命名空间)里分发根的 action。返回一个解析所有被触发的 action 处理器的 Promise。[详细介绍](../guide/actions.md)
 
 
@@ -241,7 +241,7 @@ const store = new Vuex.Store({ ...options })
 
 
 ### hasModule
 ### hasModule
 
 
-- `hasModule(path: string | Array<string>)`
+- `hasModule(path: string | Array<string>): boolean`
 
 
   检查该模块的名字是否已经被注册。[详细介绍](../guide/modules.md#模块动态注册)
   检查该模块的名字是否已经被注册。[详细介绍](../guide/modules.md#模块动态注册)