|
| 1 | +--- |
| 2 | +sidebar: auto |
| 3 | +--- |
| 4 | + |
| 5 | +# Referência da API |
| 6 | + |
| 7 | +## Vuex.Store |
| 8 | + |
| 9 | +``` js |
| 10 | +import Vuex from 'vuex' |
| 11 | + |
| 12 | +const store = new Vuex.Store({ ...options }) |
| 13 | +``` |
| 14 | + |
| 15 | +## Vuex.Store Opções do Construtor |
| 16 | + |
| 17 | +### estado |
| 18 | + |
| 19 | +- type: `Object | Function` |
| 20 | + |
| 21 | + O objeto raiz de estado para o _store_ Vuex. [Detalhes](../guide/state.md) |
| 22 | + |
| 23 | + Se você passar uma função que retorna um objeto, o objeto retornado é usado como o estado da raiz. Isso é útil quando você deseja reutilizar o objeto de estado, especialmente para reutilização de módulos. [Detalhes](../guide/modules.md#reutilizacao-do-modulo) |
| 24 | + |
| 25 | +### mutações |
| 26 | + |
| 27 | +- type: `{ [type: string]: Function }` |
| 28 | + |
| 29 | + Registra mutações no _store_. A função do manipulador sempre recebe `estado` como o 1º argumento (será o estado local do módulo se definido em um módulo) e receberá um 2º argumento _payload_ se houver um. |
| 30 | + |
| 31 | + [Detalhes](../guide/mutations.md) |
| 32 | + |
| 33 | +### ações |
| 34 | + |
| 35 | +- type: `{ [type: string]: Function }` |
| 36 | + |
| 37 | + Registra ações no _store_. A função do manipulador recebe um objeto _context_ que expõe as seguintes propriedades: |
| 38 | + |
| 39 | + ``` js |
| 40 | + { |
| 41 | + state, // o mesmo que `store.state`, ou estado local se estiver em módulos |
| 42 | + rootState, // o mesmo que `store.state`, apenas em módulos |
| 43 | + commit, // o mesmo que `store.commit` |
| 44 | + dispatch, // o mesmo que `store.dispatch` |
| 45 | + getters, // o mesmo que `store.getters`, ou com getters locais se estiver em módulos |
| 46 | + rootGetters // o mesmo que `store.getters`, apenas em módulos |
| 47 | + } |
| 48 | + ``` |
| 49 | + |
| 50 | + E também recebe um 2º argumento _payload_ se houver um. |
| 51 | + |
| 52 | + [Detalhes](../guide/actions.md) |
| 53 | + |
| 54 | +### getters |
| 55 | + |
| 56 | +- type: `{ [key: string]: Function }` |
| 57 | + |
| 58 | + Registra _getters_ no _store_. A função _getter_ recebe os seguintes argumentos: |
| 59 | + |
| 60 | + ``` |
| 61 | + state, // será estado local do módulo se definido em um módulo. |
| 62 | + getters // o mesmo que store.getters |
| 63 | + ``` |
| 64 | + |
| 65 | + Específico quando definido em um módulo |
| 66 | + |
| 67 | + ``` |
| 68 | + state, // será estado local do módulo se definido em um módulo. |
| 69 | + getters, // módulo de getters locais do módulo atual |
| 70 | + rootState, // estado global |
| 71 | + rootGetters // todos os getters |
| 72 | + ``` |
| 73 | + |
| 74 | + Os _getters_ registrados estão expostos em _store.getters_. |
| 75 | + |
| 76 | + [Detalhes](../guide/getters.md) |
| 77 | + |
| 78 | +### módulos |
| 79 | + |
| 80 | +- type: `Object` |
| 81 | + |
| 82 | + Um objeto contendo sub módulos a serem incorporados no _store_, de forma que: |
| 83 | + |
| 84 | + ``` js |
| 85 | + { |
| 86 | + key: { |
| 87 | + state, |
| 88 | + namespaced?, |
| 89 | + mutations?, |
| 90 | + actions?, |
| 91 | + getters?, |
| 92 | + modules? |
| 93 | + }, |
| 94 | + ... |
| 95 | + } |
| 96 | + ``` |
| 97 | +
|
| 98 | + Cada módulo pode conter `estado` e `mutações` semelhantes às opções raiz. O estado de um módulo será anexado ao estado da raiz do _store_ usando a chave do módulo. As mutações e _getters_ de um módulo receberão apenas o estado local do módulo como o 1º argumento em vez do estado da raiz e as ações do módulo _context.state_ também apontarão para o estado local. |
| 99 | +
|
| 100 | + [Detalhes](../guide/modules.md) |
| 101 | +
|
| 102 | +### plugins |
| 103 | +
|
| 104 | +- type: `Array<Function>` |
| 105 | +
|
| 106 | + Um _Array_ de funções de plug-in a serem aplicadas no _store_. O plug-in simplesmente recebe o _store_ como o único argumento e pode ouvir mutações (para persistência de dados de saída, registro ou depuração) ou mutações de despacho (para dados de entrada, por exemplo, websockets ou _observables_). |
| 107 | +
|
| 108 | + [Detalhes](../guide/plugins.md) |
| 109 | +
|
| 110 | +### strict |
| 111 | +
|
| 112 | +- type: `Boolean` |
| 113 | +- default: `false` |
| 114 | +
|
| 115 | + 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. |
| 116 | +
|
| 117 | + [Detalhes](../guide/strict.md) |
| 118 | +
|
| 119 | +## Vuex.Store Propriedades da Instância |
| 120 | +
|
| 121 | +### state |
| 122 | +
|
| 123 | +- type: `Object` |
| 124 | +
|
| 125 | + O estado raiz. Apenas leitura. |
| 126 | +
|
| 127 | +### getters |
| 128 | +
|
| 129 | +- type: `Object` |
| 130 | +
|
| 131 | + Expõe os _getters_ registrados. Apenas leitura. |
| 132 | +
|
| 133 | +## Vuex.Store Métodos da Instância |
| 134 | +
|
| 135 | +### commit |
| 136 | +
|
| 137 | +- `commit(type: string, payload?: any, options?: Object)` |
| 138 | +- `commit(mutation: Object, options?: Object)` |
| 139 | +
|
| 140 | + Confirma (ou faz um _Commit_ de) uma mutação. _options_ pode ter _root: true_ que permite confirmar mutações da raiz em [módulos namespaced](../guide/modules.md#namespacing). [Detalhes](../guide/mutations.md) |
| 141 | +
|
| 142 | +### dispatch |
| 143 | +
|
| 144 | +- `dispatch(type: string, payload?: any, options?: Object)` |
| 145 | +- `dispatch(action: Object, options?: Object)` |
| 146 | +
|
| 147 | + 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) |
| 148 | +
|
| 149 | +### ___replaceState |
| 150 | +
|
| 151 | +- `___replaceState(state: Object)` |
| 152 | +
|
| 153 | + Substitua o estado da raiz do _store_. Use isso apenas para fins de _hydration_ / _time-travel_. |
| 154 | +
|
| 155 | +### watch |
| 156 | +
|
| 157 | +- `watch(fn: Function, callback: Function, options?: Object): Function` |
| 158 | +
|
| 159 | + Visualiza de forma reativa um valor de retorno de `fn`, e chama o _callback_ para o retorno de chamada quando o valor for alterado. O `fn` recebe o estado do _store_ como o 1º argumento, e os _getters_ como o 2º argumento. Aceita um objeto de opções opcional que leva as mesmas opções que o método _vm.$watch_ do Vue. |
| 160 | +
|
| 161 | + Para parar um _watch_, chame a função _unwatch_ retornada. |
| 162 | +
|
| 163 | +### subscribe |
| 164 | +
|
| 165 | +- `subscribe(handler: Function): Function` |
| 166 | +
|
| 167 | + Assina as mutações do _store_. O `manipulador` é chamado após cada mutação e recebe o descritor de mutação e o estado pós-mutação como argumentos: |
| 168 | +
|
| 169 | + ``` js |
| 170 | + store.subscribe((mutation, state) => { |
| 171 | + console.log(mutation.type) |
| 172 | + console.log(mutation.payload) |
| 173 | + }) |
| 174 | + ``` |
| 175 | +
|
| 176 | + Para cancelar a assinatura, chame a função _unsubscribe_ retornada. |
| 177 | +
|
| 178 | + Mais comumente usado em plugins. [Detalhes](../guide/plugins.md) |
| 179 | +
|
| 180 | +### subscribeAction |
| 181 | +
|
| 182 | +- `subscribeAction(handler: Function): Function` |
| 183 | +
|
| 184 | + > Novo na 2.5.0 |
| 185 | +
|
| 186 | + Assina as ações do _store_. O `manipulador` é chamado para cada ação despachada e recebe o descritor de ação e o estado atual do _store_ como argumentos: |
| 187 | +
|
| 188 | + ``` js |
| 189 | + store.subscribeAction((action, state) => { |
| 190 | + console.log(action.type) |
| 191 | + console.log(action.payload) |
| 192 | + }) |
| 193 | + ``` |
| 194 | +
|
| 195 | + Para cancelar a assinatura, chame a função _unsubscribe_ retornada. |
| 196 | +
|
| 197 | + Mais comumente usado em plugins. [Detalhes](../guide/plugins.md) |
| 198 | +
|
| 199 | +### registerModule |
| 200 | +
|
| 201 | +- `registerModule(path: string | Array<string>, module: Module, options?: Object)` |
| 202 | +
|
| 203 | + Registra um módulo dinâmico. [Detalhes](../guide/modules.md#registro-de-modulo-dinamico) |
| 204 | +
|
| 205 | + _options_ can have _preserveState: true_ que permite preservar o estado anterior. Útil com renderização do lado do servidor (_server-side-rendering_). |
| 206 | +
|
| 207 | +### unregisterModule |
| 208 | +
|
| 209 | +- `unregisterModule(path: string | Array<string>)` |
| 210 | +
|
| 211 | + Cancela o registro de um módulo dinâmico. [Detalhes](../guide/modules.md#registro-de-modulo-dinamico) |
| 212 | +
|
| 213 | +### hotUpdate |
| 214 | +
|
| 215 | +- `hotUpdate(newOptions: Object)` |
| 216 | +
|
| 217 | + Faz _Hot_ _swap_ de novas ações e mutações. [Detalhes](../guide/hot-reload.md) |
| 218 | +
|
| 219 | +## Métodos Auxiliares dos Componentes |
| 220 | +
|
| 221 | +### mapState |
| 222 | +
|
| 223 | +- `mapState(namespace?: string, map: Array<string> | Object<string | function>): Object` |
| 224 | + |
| 225 | + Criar dados computados do componente que retornam a subárvore do _store_ Vuex. [Detalhes](../guide/state.md#o-auxiliar-mapstate) |
| 226 | + |
| 227 | + O 1º argumento pode ser opcionalmente uma _String_ com _namespace_. [Detalhes](../guide/modules.md#usando-metodos-auxiliares-com-namespace) |
| 228 | + |
| 229 | + O segundo objeto que compõem os argumentos pode ser uma função. `function(state: any)` |
| 230 | + |
| 231 | +### mapGetters |
| 232 | + |
| 233 | +- `mapGetters(namespace?: string, map: Array<string> | Object<string>): Object` |
| 234 | + |
| 235 | + Criar dados computados do componente que retornam o valor calculado de um _getter_. [Detalhes](../guide/getters.md#o-auxiliar-mapgetters) |
| 236 | + |
| 237 | + O 1º argumento pode ser opcionalmente uma _String_ com _namespace_. [Detalhes](../guide/modules.md#usando-metodos-auxiliares-com-namespace) |
| 238 | + |
| 239 | +### mapActions |
| 240 | + |
| 241 | +- `mapActions(namespace?: string, map: Array<string> | Object<string | function>): Object` |
| 242 | + |
| 243 | + Criar opções de métodos nos componentes que despacham uma ação. [Detalhes](../guide/actions.md#acoes-de-despacho-em-componentes) |
| 244 | + |
| 245 | + O 1º argumento pode ser opcionalmente uma _String_ com _namespace_. [Detalhes](../guide/modules.md#usando-metodos-auxiliares-com-namespace) |
| 246 | + |
| 247 | + O segundo objeto que compõem os argumentos pode ser uma função. `function(dispatch: function, ...args: any[])` |
| 248 | + |
| 249 | +### mapMutations |
| 250 | + |
| 251 | +- `mapMutations(namespace?: string, map: Array<string> | Object<string | function>): Object` |
| 252 | + |
| 253 | + Criar opções de métodos nos componentes que confirmam (ou fazem um _commit_ de) uma mutação. [Detalhes](../guide/mutations.md#confirmando-ou-fazendo-commits-de-mutacoes-em-componentes) |
| 254 | + |
| 255 | + O 1º argumento pode ser opcionalmente uma _String_ com _namespace_. [Detalhes](../guide/modules.md#usando-metodos-auxiliares-com-namespace) |
| 256 | + |
| 257 | + O segundo objeto que compõem os argumentos pode ser uma função. `function(commit: function, ...args: any[])` |
| 258 | + |
| 259 | +### createNamespacedHelpers |
| 260 | + |
| 261 | +- `createNamespacedHelpers(namespace: string): Object` |
| 262 | + |
| 263 | + Cria um componente _namespaced_ dos métodos auxiliares. O objeto retornado possui _mapState_, _mapGetters_, _mapActions_ e _mapMutations_, que estão conectados com o dado _namespace_. [Detalhes](../guide/modules.md#usando-metodos-auxiliares-com-namespace) |
0 commit comments