Skip to content

Commit eb33ed6

Browse files
authored
docs: module state declaration as function (#1741)
1 parent d98ea64 commit eb33ed6

File tree

10 files changed

+85
-85
lines changed

10 files changed

+85
-85
lines changed

docs/api/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ const store = new Vuex.Store({ ...options })
185185
})
186186
```
187187
188-
By default, new handler is added to the end of the chain, so it will be executed after other handlers that were added before. This can be overriden by adding `prepend: true` to `options`, which will add the handler to the beginning of the chain.
188+
By default, new handler is added to the end of the chain, so it will be executed after other handlers that were added before. This can be overridden by adding `prepend: true` to `options`, which will add the handler to the beginning of the chain.
189189
190190
``` js
191191
store.subscribe(handler, { prepend: true })
@@ -210,7 +210,7 @@ const store = new Vuex.Store({ ...options })
210210
})
211211
```
212212
213-
By default, new handler is added to the end of the chain, so it will be executed after other handlers that were added before. This can be overriden by adding `prepend: true` to `options`, which will add the handler to the beginning of the chain.
213+
By default, new handler is added to the end of the chain, so it will be executed after other handlers that were added before. This can be overridden by adding `prepend: true` to `options`, which will add the handler to the beginning of the chain.
214214
215215
``` js
216216
store.subscribeAction(handler, { prepend: true })

docs/fr/guide/modules.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ Pour y remédier, Vuex nous permet de diviser notre store en **modules**. Chaque
88

99
``` js
1010
const moduleA = {
11-
state: { ... },
11+
state: () => ({ ... }),
1212
mutations: { ... },
1313
actions: { ... },
1414
getters: { ... }
1515
}
1616

1717
const moduleB = {
18-
state: { ... },
18+
state: () => ({ ... }),
1919
mutations: { ... },
2020
actions: { ... }
2121
}
@@ -37,7 +37,9 @@ Dans les mutations et accesseurs d'un module, le premier argument reçu sera **l
3737

3838
``` js
3939
const moduleA = {
40-
state: { count: 0 },
40+
state: () => ({
41+
count: 0
42+
}),
4143
mutations: {
4244
increment (state) {
4345
// `state` est l'état du module local
@@ -87,14 +89,14 @@ Par défaut, les actions, mutations et accesseurs à l'intérieur d'un module so
8789

8890
Si vous souhaitez que votre module soit autosuffisant et réutilisable, vous pouvez le ranger sous un espace de nom avec `namespaced: true`. Quand le module est enregistré, tous ses accesseurs, actions et mutations seront automatiquement basés sur l'espace de nom du module dans lesquels ils sont rangés. Par exemple :
8991

90-
```js
92+
``` js
9193
const store = new Vuex.Store({
9294
modules: {
9395
account: {
9496
namespaced: true,
9597

9698
// propriétés du module
97-
state: { ... }, // l'état du module est déjà imbriqué et n'est pas affecté par l'option `namespace`
99+
state: () => ({ ... }), // l'état du module est déjà imbriqué et n'est pas affecté par l'option `namespace`
98100
getters: {
99101
isAdmin () { ... } // -> getters['account/isAdmin']
100102
},
@@ -109,7 +111,7 @@ const store = new Vuex.Store({
109111
modules: {
110112
// hérite de l'espace de nom du module parent
111113
myPage: {
112-
state: { ... },
114+
state: () => ({ ... }),
113115
getters: {
114116
profile () { ... } // -> getters['account/profile']
115117
}
@@ -119,7 +121,7 @@ const store = new Vuex.Store({
119121
posts: {
120122
namespaced: true,
121123

122-
state: { ... },
124+
state: () => ({ ... }),
123125
getters: {
124126
popular () { ... } // -> getters['account/posts/popular']
125127
}
@@ -262,7 +264,7 @@ export default {
262264

263265
Vous devez faire attention au nom d'espace imprévisible pour vos modules quand vous créez un [plugin](./plugins.md) qui fournit les modules et laisser les utilisateurs les ajouter au store de Vuex. Vos modules seront également sous espace de nom si l'utilisateur du plugin l'ajoute sous un module sous espace de nom. Pour vous adapter à la situation, vous devez recevoir la valeur de l'espace de nom via vos options de plugin :
264266

265-
```js
267+
``` js
266268
// passer la valeur d'espace de nom via une option du plugin
267269
// et retourner une fonction de plugin Vuex
268270
export function createPlugin (options = {}) {
@@ -311,11 +313,9 @@ C'est exactement le même problème qu'avec `data` dans un composant Vue. Ainsi
311313

312314
``` js
313315
const MyReusableModule = {
314-
state () {
315-
return {
316-
foo: 'bar'
317-
}
318-
},
316+
state: () => ({
317+
foo: 'bar'
318+
}),
319319
// mutations, actions, accesseurs...
320320
}
321321
```

docs/guide/modules.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ To help with that, Vuex allows us to divide our store into **modules**. Each mod
88

99
``` js
1010
const moduleA = {
11-
state: { ... },
11+
state: () => ({ ... }),
1212
mutations: { ... },
1313
actions: { ... },
1414
getters: { ... }
1515
}
1616

1717
const moduleB = {
18-
state: { ... },
18+
state: () => ({ ... }),
1919
mutations: { ... },
2020
actions: { ... }
2121
}
@@ -37,7 +37,9 @@ Inside a module's mutations and getters, the first argument received will be **t
3737

3838
``` js
3939
const moduleA = {
40-
state: { count: 0 },
40+
state: () => ({
41+
count: 0
42+
}),
4143
mutations: {
4244
increment (state) {
4345
// `state` is the local module state
@@ -94,7 +96,7 @@ const store = new Vuex.Store({
9496
namespaced: true,
9597

9698
// module assets
97-
state: { ... }, // module state is already nested and not affected by namespace option
99+
state: () => ({ ... }), // module state is already nested and not affected by namespace option
98100
getters: {
99101
isAdmin () { ... } // -> getters['account/isAdmin']
100102
},
@@ -109,7 +111,7 @@ const store = new Vuex.Store({
109111
modules: {
110112
// inherits the namespace from parent module
111113
myPage: {
112-
state: { ... },
114+
state: () => ({ ... }),
113115
getters: {
114116
profile () { ... } // -> getters['account/profile']
115117
}
@@ -119,7 +121,7 @@ const store = new Vuex.Store({
119121
posts: {
120122
namespaced: true,
121123

122-
state: { ... },
124+
state: () => ({ ... }),
123125
getters: {
124126
popular () { ... } // -> getters['account/posts/popular']
125127
}
@@ -322,11 +324,9 @@ This is actually the exact same problem with `data` inside Vue components. So th
322324

323325
``` js
324326
const MyReusableModule = {
325-
state () {
326-
return {
327-
foo: 'bar'
328-
}
329-
},
327+
state: () => ({
328+
foo: 'bar'
329+
}),
330330
// mutations, actions, getters...
331331
}
332332
```

docs/ja/guide/modules.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@
88

99
``` js
1010
const moduleA = {
11-
state: { ... },
11+
state: () => ({ ... }),
1212
mutations: { ... },
1313
actions: { ... },
1414
getters: { ... }
1515
}
1616

1717
const moduleB = {
18-
state: { ... },
18+
state: () => ({ ... }),
1919
mutations: { ... },
2020
actions: { ... }
2121
}
@@ -37,7 +37,9 @@ store.state.b // -> `moduleB` のステート
3737

3838
``` js
3939
const moduleA = {
40-
state: { count: 0 },
40+
state: () => ({
41+
count: 0
42+
}),
4143
mutations: {
4244
increment (state) {
4345
// `state` はモジュールのローカルステート
@@ -94,7 +96,7 @@ const store = new Vuex.Store({
9496
namespaced: true,
9597

9698
// モジュールのアセット
97-
state: { ... }, // モジュールステートはすでにネストされており、名前空間のオプションによって影響を受けません
99+
state: () => ({ ... }), // モジュールステートはすでにネストされており、名前空間のオプションによって影響を受けません
98100
getters: {
99101
isAdmin () { ... } // -> getters['account/isAdmin']
100102
},
@@ -109,7 +111,7 @@ const store = new Vuex.Store({
109111
modules: {
110112
// 親モジュールから名前空間を継承する
111113
myPage: {
112-
state: { ... },
114+
state: () => ({ ... }),
113115
getters: {
114116
profile () { ... } // -> getters['account/profile']
115117
}
@@ -119,7 +121,7 @@ const store = new Vuex.Store({
119121
posts: {
120122
namespaced: true,
121123

122-
state: { ... },
124+
state: () => ({ ... }),
123125
getters: {
124126
popular () { ... } // -> getters['account/posts/popular']
125127
}
@@ -318,11 +320,9 @@ store.registerModule(['nested', 'myModule'], {
318320

319321
``` js
320322
const MyReusableModule = {
321-
state () {
322-
return {
323-
foo: 'bar'
324-
}
325-
},
323+
state: () => ({
324+
foo: 'bar'
325+
}),
326326
// ミューテーション、アクション、ゲッター...
327327
}
328328
```

docs/kr/guide/modules.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@
88

99
``` js
1010
const moduleA = {
11-
state: { ... },
11+
state: () => ({ ... }),
1212
mutations: { ... },
1313
actions: { ... },
1414
getters: { ... }
1515
}
1616

1717
const moduleB = {
18-
state: { ... },
18+
state: () => ({ ... }),
1919
mutations: { ... },
2020
actions: { ... }
2121
}
@@ -37,7 +37,9 @@ store.state.b // -> moduleB'의 상태
3737

3838
``` js
3939
const moduleA = {
40-
state: { count: 0 },
40+
state: () => ({
41+
count: 0
42+
}),
4143
mutations: {
4244
increment (state) {
4345
// state는 지역 모듈 상태 입니다
@@ -94,7 +96,7 @@ const store = new Vuex.Store({
9496
namespaced: true,
9597

9698
// 모듈 자산
97-
state: { ... }, // 모듈 상태는 이미 중첩되어 있고, 네임스페이스 옵션의 영향을 받지 않음
99+
state: () => ({ ... }), // 모듈 상태는 이미 중첩되어 있고, 네임스페이스 옵션의 영향을 받지 않음
98100
getters: {
99101
isAdmin () { ... } // -> getters['account/isAdmin']
100102
},
@@ -109,7 +111,7 @@ const store = new Vuex.Store({
109111
modules: {
110112
// 부모 모듈로부터 네임스페이스를 상속받음
111113
myPage: {
112-
state: { ... },
114+
state: () => ({ ... }),
113115
getters: {
114116
profile () { ... } // -> getters['account/profile']
115117
}
@@ -119,7 +121,7 @@ const store = new Vuex.Store({
119121
posts: {
120122
namespaced: true,
121123

122-
state: { ... },
124+
state: () => ({ ... }),
123125
getters: {
124126
popular () { ... } // -> getters['account/posts/popular']
125127
}
@@ -311,11 +313,9 @@ Server Side Rendered 앱에서 상태를 유지하는 것처럼 새 모듈을
311313

312314
``` js
313315
const MyReusableModule = {
314-
state () {
315-
return {
316-
foo: 'bar'
317-
}
318-
},
316+
state: () => ({
317+
foo: 'bar'
318+
}),
319319
// 변이, 액션, getters...
320320
}
321321
```

docs/ptbr/guide/modules.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ Para ajudar com isso, o Vuex nos permite dividir nosso _store_ em **módulos**.
88

99
``` js
1010
const moduleA = {
11-
state: { ... },
11+
state: () => ({ ... }),
1212
mutations: { ... },
1313
actions: { ... },
1414
getters: { ... }
1515
}
1616

1717
const moduleB = {
18-
state: { ... },
18+
state: () => ({ ... }),
1919
mutations: { ... },
2020
actions: { ... }
2121
}
@@ -37,7 +37,9 @@ Dentro das mutações e _getters_ de um módulo, o 1º argumento recebido será
3737

3838
``` js
3939
const moduleA = {
40-
state: { count: 0 },
40+
state: () => ({
41+
count: 0
42+
}),
4143
mutations: {
4244
increment (state) {
4345
// `state` é o estado local do módulo
@@ -94,7 +96,7 @@ const store = new Vuex.Store({
9496
namespaced: true,
9597

9698
// module assets
97-
state: { ... }, // o estado do módulo já está aninhado e não é afetado pela opção de namespace
99+
state: () => ({ ... }), // o estado do módulo já está aninhado e não é afetado pela opção de namespace
98100
getters: {
99101
isAdmin () { ... } // -> getters['account/isAdmin']
100102
},
@@ -109,7 +111,7 @@ const store = new Vuex.Store({
109111
modules: {
110112
// herda o namespace do modulo pai
111113
myPage: {
112-
state: { ... },
114+
state: () => ({ ... }),
113115
getters: {
114116
profile () { ... } // -> getters['account/profile']
115117
}
@@ -119,7 +121,7 @@ const store = new Vuex.Store({
119121
posts: {
120122
namespaced: true,
121123

122-
state: { ... },
124+
state: () => ({ ... }),
123125
getters: {
124126
popular () { ... } // -> getters['account/posts/popular']
125127
}
@@ -317,11 +319,9 @@ Este é exatamente o mesmo problema com `data` dentro dos componentes Vue. Entã
317319

318320
``` js
319321
const MyReusableModule = {
320-
state () {
321-
return {
322-
foo: 'bar'
323-
}
324-
},
322+
state: () => ({
323+
foo: 'bar'
324+
}),
325325
// mutações, ações, getters...
326326
}
327327
```

0 commit comments

Comments
 (0)