From 9c9dbd84fe066ad0fce99f4bf2f9beed5b4620e7 Mon Sep 17 00:00:00 2001 From: Bruno Lesieur Date: Sat, 17 Jun 2017 15:21:36 +0200 Subject: [PATCH 01/10] Relecture api.md Signed-off-by: Bruno Lesieur --- docs/en/SUMMARY.md | 2 +- docs/en/api.md | 122 +++++++++++++++++++-------------------------- 2 files changed, 53 insertions(+), 71 deletions(-) diff --git a/docs/en/SUMMARY.md b/docs/en/SUMMARY.md index f32a242bc..2d4e8d06c 100644 --- a/docs/en/SUMMARY.md +++ b/docs/en/SUMMARY.md @@ -21,4 +21,4 @@ - [Formulaires](forms.md) - [Tests](testing.md) - [Hot Reloading](hot-reload.md) -- [Documentation API](api.md) +- [Documentation de l'API](api.md) diff --git a/docs/en/api.md b/docs/en/api.md index e7ac2320e..b39121375 100644 --- a/docs/en/api.md +++ b/docs/en/api.md @@ -1,4 +1,4 @@ -# API Reference +# Documentation API ### Vuex.Store @@ -8,78 +8,68 @@ import Vuex from 'vuex' const store = new Vuex.Store({ ...options }) ``` -### Vuex.Store Constructor Options +### Options de constructeur de Vuex.Store - **state** - type: `Object` - The root state object for the Vuex store. + L'objet state racine pour le store Vuex. - [Details](state.md) + [Détails](state.md) - **mutations** - type: `{ [type: string]: Function }` - Register mutations on the store. The handler function always receives `state` as the first argument (will be module local state if defined in a module), and receives a second `payload` argument if there is one. + Enregistrer les mutations sur le store. La fonction handler reçoit toujours `state` comme premier argument (sera le state local du module si défini dans un module), et reçoit le `payload` en second argument s'il y en a un. - [Details](mutations.md) + [Détails](mutations.md) - **actions** - type: `{ [type: string]: Function }` - Register actions on the store. The handler function receives a `context` object that exposes the following properties: + Enregistrer les actions sur le store. La fonction handler reçoit un objet `context` qui expose les propriétés suivantes : ``` js { - state, // same as store.state, or local state if in modules - rootState, // same as store.state, only in modules - commit, // same as store.commit - dispatch, // same as store.dispatch - getters // same as store.getters + state, // identique à store.state, ou au state local si dans des modules + rootState, // identique à store.state, seulement dans des modules + commit, // identique à store.commit + dispatch, // identique à store.dispatch + getters // identique à store.getters } ``` - [Details](actions.md) + [Détails](actions.md) - **getters** - type: `{ [key: string]: Function }` - Register getters on the store. The getter function receives the following arguments: + Enregistrer les getters sur le store. La fonction getter reçoit les arguments suivants : ``` - state, // will be module local state if defined in a module. - getters // same as store.getters + state, // sera le state local du module si défini dans un module. + getters, // indentique à store.getters + rootState // indentique à store.state ``` + Les getters enregistrés sont exposés sur `store.getters`. - Specific when defined in a module - - ``` - state, // will be module local state if defined in a module. - getters, // module local getters of the current module - rootState, // global state - rootGetters // all getters - ``` - - Registered getters are exposed on `store.getters`. - - [Details](getters.md) + [Détails](getters.md) - **modules** - type: `Object` - An object containing sub modules to be merged into the store, in the shape of: + Un objet contenant des sous-modules qui seront regroupés dans le store, de la forme suivante : ``` js { key: { state, - namespaced?, - mutations?, + mutations, actions?, getters?, modules? @@ -88,64 +78,64 @@ const store = new Vuex.Store({ ...options }) } ``` - Each module can contain `state` and `mutations` similar to the root options. A module's state will be attached to the store's root state using the module's key. A module's mutations and getters will only receives the module's local state as the first argument instead of the root state, and module actions' `context.state` will also point to the local state. + Chaque module peut contenir `state` et `mutations`, tout comme les options racine. Le state d'un module sera attaché au state racine du store en utilisant la clé du module. Les mutations et getters d'un module recevront seulement le state local du module en premier argument au lieu du state racine, et le `context.state` des actions du module pointeront également vers le state local. - [Details](modules.md) + [Détails](modules.md) - **plugins** - type: `Array` - An array of plugin functions to be applied to the store. The plugin simply receives the store as the only argument and can either listen to mutations (for outbound data persistence, logging, or debugging) or dispatch mutations (for inbound data e.g. websockets or observables). + Un tableau de fonctions plugin qui seront appliqués au store. Un plugin reçoit simplement le store comme seul argument et peut soit écouter les mutations (pour la persistence de données, logging ou debugging) ou dispatcher des mutations (pour les données internes, i.e. websockets ou observables). - [Details](plugins.md) + [Détails](plugins.md) - **strict** - type: `Boolean` - 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 le store Vuex en mode strict. En mode strict, toute mutation du state en dehors des handlers de mutation lancera une Error. - [Details](strict.md) + [Détails](strict.md) -### Vuex.Store Instance Properties +### Propriétés d'instance de Vuex.Store - **state** - type: `Object` - The root state. Read only. + Le state racine. Lecture seule. - **getters** - type: `Object` - Exposes registered getters. Read only. + Expose les getters enregistrés. Lecture seule. -### Vuex.Store Instance Methods +### Méthodes d'instance de Vuex.Store -- **`commit(type: string, payload?: any, options?: Object) | commit(mutation: Object, options?: Object)`** +- **`commit(type: string, payload?: any) | commit(mutation: Object)`** - Commit a mutation. `options` can have `root: true` that allows to commit root mutations in [namespaced modules](modules.md#namespacing). [Details](mutations.md) + commiter une mutation. [Détails](mutations.md) -- **`dispatch(type: string, payload?: any, options?: Object) | dispatch(action: Object, options?: Object)`** +- **`dispatch(type: string, payload?: any) | dispatch(action: Object)`** - Dispatch an action. `options` can have `root: true` that allows to dispatch root actions in [namespaced modules](modules.md#namespacing). Returns a Promise that resolves all triggered action handlers. [Details](actions.md) + Dispatcher une action. Retourne la valeur renvoyée par le handler d'action déclenché, ou une Promise si plusieurs handlers ont été déclenchés. [Détails](actions.md) - **`replaceState(state: Object)`** - Replace the store's root state. Use this only for state hydration / time-travel purposes. + Remplacer le state racine du store. Utiliser seulement pour hydrater le state ou voir le state dans le temps. - **`watch(getter: Function, cb: Function, options?: Object)`** - Reactively watch a getter function's return value, and call the callback when the value changes. The getter receives the store's state as the only argument. Accepts an optional options object that takes the same options as Vue's `vm.$watch` method. + Observer de façon réactive la valeur de retour d'une fonction getter, et appeler le callback lorsque la valeur change. Le getter reçoit le state du store comme unique argument. Accepte un objet options optionnel qui prend les mêmes options que la méthode `vm.$watch` de Vue. - To stop watching, call the returned handle function. + Pour arrêter d'observer, appeler la fonction retournée. - **`subscribe(handler: Function)`** - Subscribe to store mutations. The `handler` is called after every mutation and receives the mutation descriptor and post-mutation state as arguments: + S'abonner aux mutations du store. Le `handler` est appelé après chaque mutation et reçoit le descripteur de mutation et le state post-mutation comme arguments : ``` js store.subscribe((mutation, state) => { @@ -154,42 +144,34 @@ const store = new Vuex.Store({ ...options }) }) ``` - Most commonly used in plugins. [Details](plugins.md) + Utilisé plus communément dans les plugins. [Détails](plugins.md) - **`registerModule(path: string | Array, module: Module)`** - Register a dynamic module. [Details](modules.md#dynamic-module-registration) + Enregistrer un module dynamique. [Détails](modules.md#enregistrement-dynamique-de-module) - **`unregisterModule(path: string | Array)`** - Unregister a dynamic module. [Details](modules.md#dynamic-module-registration) + Supprimer un module dynamique. [Détails](modules.md#enregistrement-dynamique-de-module) - **`hotUpdate(newOptions: Object)`** - Hot swap new actions and mutations. [Details](hot-reload.md) - -### Component Binding Helpers - -- **`mapState(namespace?: string, map: Array | Object): Object`** - - Create component computed options that return the sub tree of the Vuex store. [Details](state.md#the-mapstate-helper) - - The first argument can optionally be a namespace string. [Details](modules.md#binding-helpers-with-namespace) + Remplacement à la volée des nouvelles actions et mutations. [Détails](hot-reload.md) -- **`mapGetters(namespace?: string, map: Array | Object): Object`** +### Helpers d'attachement au composant - Create component computed options that return the evaluated value of a getter. [Details](getters.md#the-mapgetters-helper) +- **`mapState(map: Array | Object): Object`** - The first argument can optionally be a namespace string. [Details](modules.md#binding-helpers-with-namespace) + Créer des computed properties qui retournent le sub tree du store Vuex au composant. [Détails](state.md#le-helper-mapstate) -- **`mapActions(namespace?: string, map: Array | Object): Object`** +- **`mapGetters(map: Array | Object): Object`** - Create component methods options that dispatch an action. [Details](actions.md#dispatching-actions-in-components) + Créer des computed properties qui retournent la valeur calculée d'un getter. [Détails](getters.md#le-helper-mapgetters) - The first argument can optionally be a namespace string. [Details](modules.md#binding-helpers-with-namespace) +- **`mapActions(map: Array | Object): Object`** -- **`mapMutations(namespace?: string, map: Array | Object): Object`** + Créer des méthodes de composant qui dispatchent une action. [Détails](actions.md#dispatcher-des-actions-dans-les-composants) - Create component methods options that commit a mutation. [Details](mutations.md#commiting-mutations-in-components) +- **`mapMutations(map: Array | Object): Object`** - The first argument can optionally be a namespace string. [Details](modules.md#binding-helpers-with-namespace) + Créer des méthodes de composant qui committent une mutation. [Détails](mutations.md#commiter-des-mutations-dans-les-composants) From 7a49e011151eadefdeedebe4899af3290e4dbf77 Mon Sep 17 00:00:00 2001 From: Bruno Lesieur Date: Sat, 17 Jun 2017 15:28:57 +0200 Subject: [PATCH 02/10] Line alignment. Signed-off-by: Bruno Lesieur --- docs/en/api.md | 59 +++++++++++++++++++++++++++++--------------------- 1 file changed, 34 insertions(+), 25 deletions(-) diff --git a/docs/en/api.md b/docs/en/api.md index b39121375..c60821d3a 100644 --- a/docs/en/api.md +++ b/docs/en/api.md @@ -1,4 +1,4 @@ -# Documentation API +# Documentation de l'API ### Vuex.Store @@ -8,37 +8,37 @@ import Vuex from 'vuex' const store = new Vuex.Store({ ...options }) ``` -### Options de constructeur de Vuex.Store +### Options du constructeur de Vuex.Store - **state** - - type: `Object` + - type : `Object` - L'objet state racine pour le store Vuex. + L'objet état racine pour le store Vuex. [Détails](state.md) - **mutations** - - type: `{ [type: string]: Function }` + - type : `{ [type : string]: Function }` - Enregistrer les mutations sur le store. La fonction handler reçoit toujours `state` comme premier argument (sera le state local du module si défini dans un module), et reçoit le `payload` en second argument s'il y en a un. + Enregistrer les mutations sur le store. La fonction gestionnaire reçoit toujours `state` comme premier argument (sera l'état local du module si défini dans un module), et reçoit le `payload` en second argument s'il y en a un. [Détails](mutations.md) - **actions** - - type: `{ [type: string]: Function }` + - type : `{ [type : string]: Function }` - Enregistrer les actions sur le store. La fonction handler reçoit un objet `context` qui expose les propriétés suivantes : + Enregistrer les actions sur le store. La fonction gestionnaire reçoit un objet `context` qui expose les propriétés suivantes : ``` js { - state, // identique à store.state, ou au state local si dans des modules - rootState, // identique à store.state, seulement dans des modules - commit, // identique à store.commit - dispatch, // identique à store.dispatch - getters // identique à store.getters + state, // identique à `store.state`, ou à l'état local si dans des modules + rootState, // identique à `store.state`, seulement dans des modules + commit, // identique à `store.commit` + dispatch, // identique à `store.dispatch` + getters // identique à `store.getters` } ``` @@ -46,22 +46,31 @@ const store = new Vuex.Store({ ...options }) - **getters** - - type: `{ [key: string]: Function }` + - type : `{ [key: string]: Function }` - Enregistrer les getters sur le store. La fonction getter reçoit les arguments suivants : + Enregistrer les accesseurs sur le store. La fonction accesseur reçoit les arguments suivants : ``` - state, // sera le state local du module si défini dans un module. - getters, // indentique à store.getters - rootState // indentique à store.state + state, // sera l'état local du module si défini dans un module. + getters, // indentique à `store.getters` ``` + + Spécifique quand défini dans un module. + + ``` + + + rootState // indentique à `store.state` + + ``` + Les getters enregistrés sont exposés sur `store.getters`. [Détails](getters.md) - **modules** - - type: `Object` + - type : `Object` Un objet contenant des sous-modules qui seront regroupés dans le store, de la forme suivante : @@ -84,7 +93,7 @@ const store = new Vuex.Store({ ...options }) - **plugins** - - type: `Array` + - type : `Array` Un tableau de fonctions plugin qui seront appliqués au store. Un plugin reçoit simplement le store comme seul argument et peut soit écouter les mutations (pour la persistence de données, logging ou debugging) ou dispatcher des mutations (pour les données internes, i.e. websockets ou observables). @@ -92,7 +101,7 @@ const store = new Vuex.Store({ ...options }) - **strict** - - type: `Boolean` + - type : `Boolean` - default: `false` Force le store Vuex en mode strict. En mode strict, toute mutation du state en dehors des handlers de mutation lancera une Error. @@ -103,23 +112,23 @@ const store = new Vuex.Store({ ...options }) - **state** - - type: `Object` + - type : `Object` Le state racine. Lecture seule. - **getters** - - type: `Object` + - type : `Object` Expose les getters enregistrés. Lecture seule. ### Méthodes d'instance de Vuex.Store -- **`commit(type: string, payload?: any) | commit(mutation: Object)`** +- **`commit(type : string, payload?: any) | commit(mutation: Object)`** commiter une mutation. [Détails](mutations.md) -- **`dispatch(type: string, payload?: any) | dispatch(action: Object)`** +- **`dispatch(type : string, payload?: any) | dispatch(action: Object)`** Dispatcher une action. Retourne la valeur renvoyée par le handler d'action déclenché, ou une Promise si plusieurs handlers ont été déclenchés. [Détails](actions.md) From cfa1facb9c849cb4eaf0333004d191b84417d751 Mon Sep 17 00:00:00 2001 From: Bruno Lesieur Date: Sat, 17 Jun 2017 15:32:42 +0200 Subject: [PATCH 03/10] aligment options Signed-off-by: Bruno Lesieur --- docs/en/api.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/en/api.md b/docs/en/api.md index c60821d3a..cee1ad75b 100644 --- a/docs/en/api.md +++ b/docs/en/api.md @@ -51,17 +51,17 @@ const store = new Vuex.Store({ ...options }) Enregistrer les accesseurs sur le store. La fonction accesseur reçoit les arguments suivants : ``` - state, // sera l'état local du module si défini dans un module. - getters, // indentique à `store.getters` + state, // sera l'état local du module si défini dans un module. + getters // indentique à `store.getters` ``` - Spécifique quand défini dans un module. + Spécifiquement quand défini dans un module ``` - - - rootState // indentique à `store.state` - + state, // sera l'état local du module si défini dans un module. + getters, // module local getters of the current module + rootState // état global + rootGetters // tous les accesseurs ``` Les getters enregistrés sont exposés sur `store.getters`. @@ -72,13 +72,14 @@ const store = new Vuex.Store({ ...options }) - type : `Object` - Un objet contenant des sous-modules qui seront regroupés dans le store, de la forme suivante : + Un objet contenant des sous-modules qui seront regroupés dans le store, sous la forme suivante : ``` js { key: { state, - mutations, + namespaced?, + mutations?, actions?, getters?, modules? From aa5bf469bfedd41fe8a0e777fa2b921a037f78b5 Mon Sep 17 00:00:00 2001 From: Bruno Lesieur Date: Sat, 17 Jun 2017 15:48:44 +0200 Subject: [PATCH 04/10] Api aligments Signed-off-by: Bruno Lesieur --- docs/en/api.md | 42 ++++++++++++++++++++++-------------------- 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/docs/en/api.md b/docs/en/api.md index cee1ad75b..62336c229 100644 --- a/docs/en/api.md +++ b/docs/en/api.md @@ -1,6 +1,6 @@ # Documentation de l'API -### Vuex.Store +### `Vuex.Store` ``` js import Vuex from 'vuex' @@ -8,7 +8,7 @@ import Vuex from 'vuex' const store = new Vuex.Store({ ...options }) ``` -### Options du constructeur de Vuex.Store +### Options du constructeur de `Vuex.Store` - **state** @@ -88,7 +88,7 @@ const store = new Vuex.Store({ ...options }) } ``` - Chaque module peut contenir `state` et `mutations`, tout comme les options racine. Le state d'un module sera attaché au state racine du store en utilisant la clé du module. Les mutations et getters d'un module recevront seulement le state local du module en premier argument au lieu du state racine, et le `context.state` des actions du module pointeront également vers le state local. + Chaque module peut contenir `state` et `mutations`, tout comme les options racine. L'état d'un module sera attaché à l'état racine du store en utilisant la clé du module. Les mutations et accesseurs d'un module recevront seulement l'état local du module en premier argument au lieu de l'état racine, et le `context.state` des actions du module pointeront également vers l'état local. [Détails](modules.md) @@ -96,7 +96,7 @@ const store = new Vuex.Store({ ...options }) - type : `Array` - Un tableau de fonctions plugin qui seront appliqués au store. Un plugin reçoit simplement le store comme seul argument et peut soit écouter les mutations (pour la persistence de données, logging ou debugging) ou dispatcher des mutations (pour les données internes, i.e. websockets ou observables). + Un tableau de fonctions plugin qui seront appliqués au store. Un plugin reçoit simplement le store comme seul argument et peut soit écouter les mutations (pour la persistence de données, les logs ou le débogage) ou propager des mutations (pour les données internes, c.-à-d. websockets ou observables). [Détails](plugins.md) @@ -105,47 +105,47 @@ const store = new Vuex.Store({ ...options }) - type : `Boolean` - default: `false` - Force le store Vuex en mode strict. En mode strict, toute mutation du state en dehors des handlers de mutation lancera une Error. + Force le store Vuex en mode strict. En mode strict, toute mutation de l'état en dehors des gestionnaires de mutation lancera une erreur. [Détails](strict.md) -### Propriétés d'instance de Vuex.Store +### Propriétés d'instance de `Vuex.Store` - **state** - type : `Object` - Le state racine. Lecture seule. + L'état racine. Lecture seule. - **getters** - type : `Object` - Expose les getters enregistrés. Lecture seule. + Expose les accesseurs enregistrés. Lecture seule. -### Méthodes d'instance de Vuex.Store +### Méthodes d'instance de `Vuex.Store` -- **`commit(type : string, payload?: any) | commit(mutation: Object)`** +- **`commit(type: string, payload?: any, options?: Object) | commit(mutation: Object, options?: Object)`** - commiter une mutation. [Détails](mutations.md) + Acter une mutation. `options` peut avoir `root: true` ce qui permet d'acter des mutations racines dans des [modules sous espace de nom](modules.md#namespacing). [Détails](mutations.md) -- **`dispatch(type : string, payload?: any) | dispatch(action: Object)`** +- **`dispatch(type : string, payload?: any, options?: Object) | dispatch(action: Object, options?: Object)`** - Dispatcher une action. Retourne la valeur renvoyée par le handler d'action déclenché, ou une Promise si plusieurs handlers ont été déclenchés. [Détails](actions.md) + Propager une action. Retourne la valeur renvoyée par le gestionnaire d'action déclenché, ou une Promesse si plusieurs gestionnaire ont été déclenchés. [Détails](actions.md) - **`replaceState(state: Object)`** - Remplacer le state racine du store. Utiliser seulement pour hydrater le state ou voir le state dans le temps. + Remplacer l'état racine du store. Utiliser seulement pour hydrater l'état ou voir l'état dans le temps. - **`watch(getter: Function, cb: Function, options?: Object)`** - Observer de façon réactive la valeur de retour d'une fonction getter, et appeler le callback lorsque la valeur change. Le getter reçoit le state du store comme unique argument. Accepte un objet options optionnel qui prend les mêmes options que la méthode `vm.$watch` de Vue. + Observer de façon réactive la valeur de retour d'une fonction accesseur, et appeler la fonction de rappel lorsque la valeur change. L'accesseur reçoit l'état du store comme unique argument. Accepte un objet options optionnel qui prend les mêmes options que la méthode `vm.$watch` de Vue. - Pour arrêter d'observer, appeler la fonction retournée. + Pour arrêter d'observer, appeler la fonction gestionnaire retournée. - **`subscribe(handler: Function)`** - S'abonner aux mutations du store. Le `handler` est appelé après chaque mutation et reçoit le descripteur de mutation et le state post-mutation comme arguments : + S'abonner aux mutations du store. Le `handler` est appelé après chaque mutation et reçoit le descripteur de mutation et l'état post-mutation comme arguments : ``` js store.subscribe((mutation, state) => { @@ -168,11 +168,13 @@ const store = new Vuex.Store({ ...options }) Remplacement à la volée des nouvelles actions et mutations. [Détails](hot-reload.md) -### Helpers d'attachement au composant +### Fonctions utilitaires d'attachement au composant -- **`mapState(map: Array | Object): Object`** +- **`mapState(namespace?: string, map: Array | Object): Object`** - Créer des computed properties qui retournent le sub tree du store Vuex au composant. [Détails](state.md#le-helper-mapstate) + Créer des propriétés calculées qui retournent le sous arbre du store Vuex au composant. [Détails](state.md#le-helper-mapstate) + + Le premier argument peut être de façon optionnel un chaîne d'espace de nom [Details](modules.md#Fonctions-utilitaires-liées-avec-espace-de-nom) - **`mapGetters(map: Array | Object): Object`** From 315d4546abdb4572d3ca041b5dc900f71f903811 Mon Sep 17 00:00:00 2001 From: Bruno Lesieur Date: Sat, 17 Jun 2017 15:51:49 +0200 Subject: [PATCH 05/10] New line addition Signed-off-by: Bruno Lesieur --- docs/en/api.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/en/api.md b/docs/en/api.md index 62336c229..528891082 100644 --- a/docs/en/api.md +++ b/docs/en/api.md @@ -174,16 +174,18 @@ const store = new Vuex.Store({ ...options }) Créer des propriétés calculées qui retournent le sous arbre du store Vuex au composant. [Détails](state.md#le-helper-mapstate) - Le premier argument peut être de façon optionnel un chaîne d'espace de nom [Details](modules.md#Fonctions-utilitaires-liées-avec-espace-de-nom) + Le premier argument peut être de façon optionnel un chaîne d'espace de nom. [Details](modules.md#Fonctions-utilitaires-liées-avec-espace-de-nom) -- **`mapGetters(map: Array | Object): Object`** +- **`mapGetters(namespace?: string, map: Array | Object): Object`** - Créer des computed properties qui retournent la valeur calculée d'un getter. [Détails](getters.md#le-helper-mapgetters) + Créer des propriétés calculées qui retournent la valeur calculée d'un accesseur. [Détails](getters.md#la-function-utilitaire-mapgetters) + + Le premier argument peut être de façon optionnel un chaîne d'espace de nom. [Details](modules.md#Fonctions-utilitaires-liées-avec-espace-de-nom) - **`mapActions(map: Array | Object): Object`** - Créer des méthodes de composant qui dispatchent une action. [Détails](actions.md#dispatcher-des-actions-dans-les-composants) + Créer des méthodes de composant qui propagent une action. [Détails](actions.md#propager-des-actions-dans-les-composants) - **`mapMutations(map: Array | Object): Object`** - Créer des méthodes de composant qui committent une mutation. [Détails](mutations.md#commiter-des-mutations-dans-les-composants) + Créer des méthodes de composant qui actent une mutation. [Détails](mutations.md#acter-des-mutations-dans-les-composants) From d244645c3833f68e9e269ec5609ce0ad41b1989b Mon Sep 17 00:00:00 2001 From: Bruno Lesieur Date: Sat, 17 Jun 2017 15:52:49 +0200 Subject: [PATCH 06/10] Next Signed-off-by: Bruno Lesieur --- docs/en/api.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/en/api.md b/docs/en/api.md index 528891082..6d6df3e0d 100644 --- a/docs/en/api.md +++ b/docs/en/api.md @@ -186,6 +186,8 @@ const store = new Vuex.Store({ ...options }) Créer des méthodes de composant qui propagent une action. [Détails](actions.md#propager-des-actions-dans-les-composants) + Le premier argument peut être de façon optionnel un chaîne d'espace de nom. [Details](modules.md#Fonctions-utilitaires-liées-avec-espace-de-nom) + - **`mapMutations(map: Array | Object): Object`** Créer des méthodes de composant qui actent une mutation. [Détails](mutations.md#acter-des-mutations-dans-les-composants) From 684de066e0dd9deb18cb547e9585d53997ffa740 Mon Sep 17 00:00:00 2001 From: Bruno Lesieur Date: Sat, 17 Jun 2017 15:53:56 +0200 Subject: [PATCH 07/10] Dernier ajout. Signed-off-by: Bruno Lesieur --- docs/en/api.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/en/api.md b/docs/en/api.md index 6d6df3e0d..e9152a374 100644 --- a/docs/en/api.md +++ b/docs/en/api.md @@ -182,12 +182,14 @@ const store = new Vuex.Store({ ...options }) Le premier argument peut être de façon optionnel un chaîne d'espace de nom. [Details](modules.md#Fonctions-utilitaires-liées-avec-espace-de-nom) -- **`mapActions(map: Array | Object): Object`** +- **`mapActions(namespace?: string, map: Array | Object): Object`** Créer des méthodes de composant qui propagent une action. [Détails](actions.md#propager-des-actions-dans-les-composants) Le premier argument peut être de façon optionnel un chaîne d'espace de nom. [Details](modules.md#Fonctions-utilitaires-liées-avec-espace-de-nom) -- **`mapMutations(map: Array | Object): Object`** +- **`mapMutations(namespace?: string, map: Array | Object): Object`** Créer des méthodes de composant qui actent une mutation. [Détails](mutations.md#acter-des-mutations-dans-les-composants) + + Le premier argument peut être de façon optionnel un chaîne d'espace de nom. [Details](modules.md#Fonctions-utilitaires-liées-avec-espace-de-nom) From 15d78d88130b367de55b29e5cd614a81c43dd671 Mon Sep 17 00:00:00 2001 From: Bruno Lesieur Date: Sat, 17 Jun 2017 15:55:09 +0200 Subject: [PATCH 08/10] =?UTF-8?q?Relecture=20@haeresis=20compl=C3=A8te.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Bruno Lesieur --- docs/en/api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/api.md b/docs/en/api.md index e9152a374..5fdb03544 100644 --- a/docs/en/api.md +++ b/docs/en/api.md @@ -60,7 +60,7 @@ const store = new Vuex.Store({ ...options }) ``` state, // sera l'état local du module si défini dans un module. getters, // module local getters of the current module - rootState // état global + rootState, // état global rootGetters // tous les accesseurs ``` From 82111eb745551c09564c1473a3920e7f338d18a8 Mon Sep 17 00:00:00 2001 From: Bruno Lesieur Date: Mon, 19 Jun 2017 17:55:45 +0200 Subject: [PATCH 09/10] Update SUMMARY.md Signed-off-by: Bruno Lesieur --- docs/en/SUMMARY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/SUMMARY.md b/docs/en/SUMMARY.md index 2d4e8d06c..befb7991b 100644 --- a/docs/en/SUMMARY.md +++ b/docs/en/SUMMARY.md @@ -5,7 +5,7 @@ - [Vous cherchez la documentation de la v1.0 ?](https://github.com/vuejs/vuex/tree/1.0/docs) -- [Release Notes](https://github.com/vuejs/vuex/releases) +- [Notes de version](https://github.com/vuejs/vuex/releases) - [Installation](installation.md) - [Vuex, qu'est-ce que c'est ?](intro.md) - [Pour commencer](getting-started.md) From 3ca41227f4300b5e98340f5307583bf042d4028f Mon Sep 17 00:00:00 2001 From: Bruno Lesieur Date: Thu, 29 Jun 2017 09:04:16 +0200 Subject: [PATCH 10/10] Review de @Kocal Signed-off-by: Bruno Lesieur --- docs/en/api.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/en/api.md b/docs/en/api.md index 5fdb03544..eb0b2034c 100644 --- a/docs/en/api.md +++ b/docs/en/api.md @@ -14,13 +14,13 @@ const store = new Vuex.Store({ ...options }) - type : `Object` - L'objet état racine pour le store Vuex. + L'objet d'état racine pour le store Vuex. [Détails](state.md) - **mutations** - - type : `{ [type : string]: Function }` + - type : `{ [type: string]: Function }` Enregistrer les mutations sur le store. La fonction gestionnaire reçoit toujours `state` comme premier argument (sera l'état local du module si défini dans un module), et reçoit le `payload` en second argument s'il y en a un. @@ -28,7 +28,7 @@ const store = new Vuex.Store({ ...options }) - **actions** - - type : `{ [type : string]: Function }` + - type : `{ [type: string]: Function }` Enregistrer les actions sur le store. La fonction gestionnaire reçoit un objet `context` qui expose les propriétés suivantes : @@ -55,7 +55,7 @@ const store = new Vuex.Store({ ...options }) getters // indentique à `store.getters` ``` - Spécifiquement quand défini dans un module + Arguments spécifiques quand défini dans un module ``` state, // sera l'état local du module si défini dans un module. @@ -64,7 +64,7 @@ const store = new Vuex.Store({ ...options }) rootGetters // tous les accesseurs ``` - Les getters enregistrés sont exposés sur `store.getters`. + Les accesseurs enregistrés sont exposés sur `store.getters`. [Détails](getters.md) @@ -96,7 +96,7 @@ const store = new Vuex.Store({ ...options }) - type : `Array` - Un tableau de fonctions plugin qui seront appliqués au store. Un plugin reçoit simplement le store comme seul argument et peut soit écouter les mutations (pour la persistence de données, les logs ou le débogage) ou propager des mutations (pour les données internes, c.-à-d. websockets ou observables). + Un tableau de fonctions plugins qui seront appliquées au store. Un plugin reçoit simplement le store comme seul argument et peut soit écouter les mutations (pour la persistence de données, les logs ou le débogage) ou propager des mutations (pour les données internes, c.-à-d. websockets ou observables). [Détails](plugins.md) @@ -131,15 +131,15 @@ const store = new Vuex.Store({ ...options }) - **`dispatch(type : string, payload?: any, options?: Object) | dispatch(action: Object, options?: Object)`** - Propager une action. Retourne la valeur renvoyée par le gestionnaire d'action déclenché, ou une Promesse si plusieurs gestionnaire ont été déclenchés. [Détails](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. [Détails](actions.md) - **`replaceState(state: Object)`** - Remplacer l'état racine du store. Utiliser seulement pour hydrater l'état ou voir l'état dans le temps. + Remplacer l'état racine du store. Utiliser seulement pour hydrater l'état ou dans le but de voyager dans le temps. - **`watch(getter: Function, cb: Function, options?: Object)`** - Observer de façon réactive la valeur de retour d'une fonction accesseur, et appeler la fonction de rappel lorsque la valeur change. L'accesseur reçoit l'état du store comme unique argument. Accepte un objet options optionnel qui prend les mêmes options que la méthode `vm.$watch` de Vue. + Observer de façon réactive la valeur de retour d'une fonction accesseur, et appeler la fonction de rappel lorsque la valeur change. L'accesseur reçoit l'état du store comme unique argument. Accepte un objet optionnel d'options qui prend les mêmes options que la méthode `vm.$watch` de Vue. Pour arrêter d'observer, appeler la fonction gestionnaire retournée. @@ -174,22 +174,22 @@ const store = new Vuex.Store({ ...options }) Créer des propriétés calculées qui retournent le sous arbre du store Vuex au composant. [Détails](state.md#le-helper-mapstate) - Le premier argument peut être de façon optionnel un chaîne d'espace de nom. [Details](modules.md#Fonctions-utilitaires-liées-avec-espace-de-nom) + Le premier argument peut être de façon optionnel une chaîne d'espace de nom. [Details](modules.md#Fonctions-utilitaires-liées-avec-espace-de-nom) - **`mapGetters(namespace?: string, map: Array | Object): Object`** Créer des propriétés calculées qui retournent la valeur calculée d'un accesseur. [Détails](getters.md#la-function-utilitaire-mapgetters) - Le premier argument peut être de façon optionnel un chaîne d'espace de nom. [Details](modules.md#Fonctions-utilitaires-liées-avec-espace-de-nom) + Le premier argument peut être de façon optionnel une chaîne d'espace de nom. [Details](modules.md#Fonctions-utilitaires-liées-avec-espace-de-nom) - **`mapActions(namespace?: string, map: Array | Object): Object`** Créer des méthodes de composant qui propagent une action. [Détails](actions.md#propager-des-actions-dans-les-composants) - Le premier argument peut être de façon optionnel un chaîne d'espace de nom. [Details](modules.md#Fonctions-utilitaires-liées-avec-espace-de-nom) + Le premier argument peut être de façon optionnel une chaîne d'espace de nom. [Details](modules.md#Fonctions-utilitaires-liées-avec-espace-de-nom) - **`mapMutations(namespace?: string, map: Array | Object): Object`** Créer des méthodes de composant qui actent une mutation. [Détails](mutations.md#acter-des-mutations-dans-les-composants) - Le premier argument peut être de façon optionnel un chaîne d'espace de nom. [Details](modules.md#Fonctions-utilitaires-liées-avec-espace-de-nom) + Le premier argument peut être de façon optionnel une chaîne d'espace de nom. [Details](modules.md#Fonctions-utilitaires-liées-avec-espace-de-nom)