Skip to content

Commit 7ead1d8

Browse files
committed
update API reference for helpers
1 parent a701210 commit 7ead1d8

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

docs/en/api.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ const store = new Vuex.Store({ ...options })
4949
- type: `{ [key: string]: Function }`
5050

5151
Register getters on the store. The getter function receives the following arguments:
52-
52+
5353
```
5454
state, // will be module local state if defined in a module.
5555
getters, // same as store.getters
@@ -160,18 +160,26 @@ const store = new Vuex.Store({ ...options })
160160
161161
### Component Binding Helpers
162162
163-
- **`mapState(map: Array<string> | Object): Object`**
163+
- **`mapState(namespace?: string, map: Array<string> | Object): Object`**
164164
165165
Create component computed options that return the sub tree of the Vuex store. [Details](state.md#the-mapstate-helper)
166166
167-
- **`mapGetters(map: Array<string> | Object): Object`**
167+
The first argument can optionally be a namespace string. [Details](modules.md#binding-helpers-with-namespace)
168+
169+
- **`mapGetters(namespace?: string, map: Array<string> | Object): Object`**
168170
169171
Create component computed options that return the evaluated value of a getter. [Details](getters.md#the-mapgetters-helper)
170172
171-
- **`mapActions(map: Array<string> | Object): Object`**
173+
The first argument can optionally be a namespace string. [Details](modules.md#binding-helpers-with-namespace)
174+
175+
- **`mapActions(namespace?: string, map: Array<string> | Object): Object`**
172176
173177
Create component methods options that dispatch an action. [Details](actions.md#dispatching-actions-in-components)
174178
175-
- **`mapMutations(map: Array<string> | Object): Object`**
179+
The first argument can optionally be a namespace string. [Details](modules.md#binding-helpers-with-namespace)
180+
181+
- **`mapMutations(namespace?: string, map: Array<string> | Object): Object`**
176182
177183
Create component methods options that commit a mutation. [Details](mutations.md#commiting-mutations-in-components)
184+
185+
The first argument can optionally be a namespace string. [Details](modules.md#binding-helpers-with-namespace)

0 commit comments

Comments
 (0)