Skip to content

Commit 85ab92e

Browse files
fsblemosktsn
authored andcommitted
complement preserveState section (#1484)
1 parent 31dec55 commit 85ab92e

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

docs/guide/modules.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,8 +295,12 @@ Dynamic module registration makes it possible for other Vue plugins to also leve
295295

296296
You can also remove a dynamically registered module with `store.unregisterModule(moduleName)`. Note you cannot remove static modules (declared at store creation) with this method.
297297

298+
#### Preserving state
299+
298300
It may be likely that you want to preserve the previous state when registering a new module, such as preserving state from a Server Side Rendered app. You can achieve this with `preserveState` option: `store.registerModule('a', module, { preserveState: true })`
299301

302+
When you set `preserveState: true`, the module is registered, actions, mutations and getters are added to the store, but the state not. It's assumed that your store state already contains state for that module and you don't want to overwrite it.
303+
300304
### Module Reuse
301305

302306
Sometimes we may need to create multiple instances of a module, for example:

docs/ptbr/guide/modules.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -296,8 +296,12 @@ O registro de módulo dinâmico possibilita que outros plug-ins Vue aproveitem t
296296

297297
Você também pode remover um módulo dinamicamente registrado com o `store.unregisterModule(moduleName)`. Note que você não pode remover módulos estáticos (declarados na criação do _store_) com este método.
298298

299+
#### Preservando o estado
300+
299301
É bem provável que você queira preservar o estado anterior ao registrar um novo módulo, como preservar o estado de um aplicativo Renderizado no Lado do Servidor (_Server_ _Side_ _Rendered_). Você pode fazer isso com a opção `preserveState`:`store.registerModule('a', module, {preserveState: true})`
300302

303+
Quando você informa `preserveState: true`, o módulo é registrado, as ações, mutações e _getters_ são incluídos no _store_, mas o estado não. É assumido que estado da sua _store_ já contém um estado para aquele módulo e você não quer sobrescrevê-lo.
304+
301305
### Reutilização do Módulo
302306

303307
Às vezes, podemos precisar criar várias instâncias de um módulo, por exemplo:

0 commit comments

Comments
 (0)