Skip to content

Commit 22b85dd

Browse files
authored
Merge pull request #19 from vuejs-fr/api
Relecture de `api.md`
2 parents 236e54f + 3ca4122 commit 22b85dd

File tree

2 files changed

+65
-65
lines changed

2 files changed

+65
-65
lines changed

docs/en/SUMMARY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<!--/email_off-->
66
77
- [Vous cherchez la documentation de la v1.0 ?](https://github.com/vuejs/vuex/tree/1.0/docs)
8-
- [Release Notes](https://github.com/vuejs/vuex/releases)
8+
- [Notes de version](https://github.com/vuejs/vuex/releases)
99
- [Installation](installation.md)
1010
- [Vuex, qu'est-ce que c'est ?](intro.md)
1111
- [Pour commencer](getting-started.md)
@@ -21,4 +21,4 @@
2121
- [Gestion des formulaires](forms.md)
2222
- [Tests](testing.md)
2323
- [Rechargement à chaud](hot-reload.md)
24-
- [Documentation API](api.md)
24+
- [Documentation de l'API](api.md)

docs/en/api.md

Lines changed: 63 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,78 @@
1-
# API Reference
1+
# Documentation de l'API
22

3-
### Vuex.Store
3+
### `Vuex.Store`
44

55
``` js
66
import Vuex from 'vuex'
77

88
const store = new Vuex.Store({ ...options })
99
```
1010

11-
### Vuex.Store Constructor Options
11+
### Options du constructeur de `Vuex.Store`
1212

1313
- **state**
1414

15-
- type: `Object`
15+
- type : `Object`
1616

17-
The root state object for the Vuex store.
17+
L'objet d'état racine pour le store Vuex.
1818

19-
[Details](state.md)
19+
[Détails](state.md)
2020

2121
- **mutations**
2222

23-
- type: `{ [type: string]: Function }`
23+
- type : `{ [type: string]: Function }`
2424

25-
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.
25+
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.
2626

27-
[Details](mutations.md)
27+
[Détails](mutations.md)
2828

2929
- **actions**
3030

31-
- type: `{ [type: string]: Function }`
31+
- type : `{ [type: string]: Function }`
3232

33-
Register actions on the store. The handler function receives a `context` object that exposes the following properties:
33+
Enregistrer les actions sur le store. La fonction gestionnaire reçoit un objet `context` qui expose les propriétés suivantes :
3434

3535
``` js
3636
{
37-
state, // same as store.state, or local state if in modules
38-
rootState, // same as store.state, only in modules
39-
commit, // same as store.commit
40-
dispatch, // same as store.dispatch
41-
getters // same as store.getters
37+
state, // identique à `store.state`, ou à l'état local si dans des modules
38+
rootState, // identique à `store.state`, seulement dans des modules
39+
commit, // identique à `store.commit`
40+
dispatch, // identique à `store.dispatch`
41+
getters // identique à `store.getters`
4242
}
4343
```
4444

45-
[Details](actions.md)
45+
[Détails](actions.md)
4646

4747
- **getters**
4848

49-
- type: `{ [key: string]: Function }`
49+
- type : `{ [key: string]: Function }`
5050

51-
Register getters on the store. The getter function receives the following arguments:
51+
Enregistrer les accesseurs sur le store. La fonction accesseur reçoit les arguments suivants :
5252

5353
```
54-
state, // will be module local state if defined in a module.
55-
getters // same as store.getters
54+
state, // sera l'état local du module si défini dans un module.
55+
getters // indentique à `store.getters`
5656
```
5757

58-
Specific when defined in a module
58+
Arguments spécifiques quand défini dans un module
5959

6060
```
61-
state, // will be module local state if defined in a module.
61+
state, // sera l'état local du module si défini dans un module.
6262
getters, // module local getters of the current module
63-
rootState, // global state
64-
rootGetters // all getters
63+
rootState, // état global
64+
rootGetters // tous les accesseurs
6565
```
6666

67-
Registered getters are exposed on `store.getters`.
67+
Les accesseurs enregistrés sont exposés sur `store.getters`.
6868

69-
[Details](getters.md)
69+
[Détails](getters.md)
7070

7171
- **modules**
7272

73-
- type: `Object`
73+
- type : `Object`
7474

75-
An object containing sub modules to be merged into the store, in the shape of:
75+
Un objet contenant des sous-modules qui seront regroupés dans le store, sous la forme suivante :
7676

7777
``` js
7878
{
@@ -88,64 +88,64 @@ const store = new Vuex.Store({ ...options })
8888
}
8989
```
9090

91-
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.
91+
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.
9292
93-
[Details](modules.md)
93+
[Détails](modules.md)
9494
9595
- **plugins**
9696
97-
- type: `Array<Function>`
97+
- type : `Array<Function>`
9898
99-
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).
99+
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).
100100
101-
[Details](plugins.md)
101+
[Détails](plugins.md)
102102
103103
- **strict**
104104
105-
- type: `Boolean`
105+
- type : `Boolean`
106106
- default: `false`
107107
108-
Force the Vuex store into strict mode. In strict mode any mutations to Vuex state outside of mutation handlers will throw an Error.
108+
Force le store Vuex en mode strict. En mode strict, toute mutation de l'état en dehors des gestionnaires de mutation lancera une erreur.
109109

110-
[Details](strict.md)
110+
[Détails](strict.md)
111111

112-
### Vuex.Store Instance Properties
112+
### Propriétés d'instance de `Vuex.Store`
113113
114114
- **state**
115115
116-
- type: `Object`
116+
- type : `Object`
117117
118-
The root state. Read only.
118+
L'état racine. Lecture seule.
119119

120120
- **getters**
121121

122-
- type: `Object`
122+
- type : `Object`
123123

124-
Exposes registered getters. Read only.
124+
Expose les accesseurs enregistrés. Lecture seule.
125125

126-
### Vuex.Store Instance Methods
126+
### Méthodes d'instance de `Vuex.Store`
127127
128128
- **`commit(type: string, payload?: any, options?: Object) | commit(mutation: Object, options?: Object)`**
129129
130-
Commit a mutation. `options` can have `root: true` that allows to commit root mutations in [namespaced modules](modules.md#namespacing). [Details](mutations.md)
130+
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)
131131

132-
- **`dispatch(type: string, payload?: any, options?: Object) | dispatch(action: Object, options?: Object)`**
132+
- **`dispatch(type : string, payload?: any, options?: Object) | dispatch(action: Object, options?: Object)`**
133133

134-
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)
134+
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)
135135
136136
- **`replaceState(state: Object)`**
137137
138-
Replace the store's root state. Use this only for state hydration / time-travel purposes.
138+
Remplacer l'état racine du store. Utiliser seulement pour hydrater l'état ou dans le but de voyager dans le temps.
139139
140140
- **`watch(getter: Function, cb: Function, options?: Object)`**
141141
142-
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.
142+
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.
143143
144-
To stop watching, call the returned handle function.
144+
Pour arrêter d'observer, appeler la fonction gestionnaire retournée.
145145

146146
- **`subscribe(handler: Function)`**
147147

148-
Subscribe to store mutations. The `handler` is called after every mutation and receives the mutation descriptor and post-mutation state as arguments:
148+
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 :
149149

150150
``` js
151151
store.subscribe((mutation, state) => {
@@ -154,42 +154,42 @@ const store = new Vuex.Store({ ...options })
154154
})
155155
```
156156

157-
Most commonly used in plugins. [Details](plugins.md)
157+
Utilisé plus communément dans les plugins. [Détails](plugins.md)
158158

159159
- **`registerModule(path: string | Array<string>, module: Module)`**
160160

161-
Register a dynamic module. [Details](modules.md#dynamic-module-registration)
161+
Enregistrer un module dynamique. [Détails](modules.md#enregistrement-dynamique-de-module)
162162

163163
- **`unregisterModule(path: string | Array<string>)`**
164164

165-
Unregister a dynamic module. [Details](modules.md#dynamic-module-registration)
165+
Supprimer un module dynamique. [Détails](modules.md#enregistrement-dynamique-de-module)
166166

167167
- **`hotUpdate(newOptions: Object)`**
168168

169-
Hot swap new actions and mutations. [Details](hot-reload.md)
169+
Remplacement à la volée des nouvelles actions et mutations. [Détails](hot-reload.md)
170170

171-
### Component Binding Helpers
171+
### Fonctions utilitaires d'attachement au composant
172172
173173
- **`mapState(namespace?: string, map: Array<string> | Object): Object`**
174174
175-
Create component computed options that return the sub tree of the Vuex store. [Details](state.md#the-mapstate-helper)
175+
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)
176176
177-
The first argument can optionally be a namespace string. [Details](modules.md#binding-helpers-with-namespace)
177+
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)
178178

179179
- **`mapGetters(namespace?: string, map: Array<string> | Object): Object`**
180180

181-
Create component computed options that return the evaluated value of a getter. [Details](getters.md#the-mapgetters-helper)
181+
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)
182182
183-
The first argument can optionally be a namespace string. [Details](modules.md#binding-helpers-with-namespace)
183+
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)
184184

185185
- **`mapActions(namespace?: string, map: Array<string> | Object): Object`**
186186

187-
Create component methods options that dispatch an action. [Details](actions.md#dispatching-actions-in-components)
187+
Créer des méthodes de composant qui propagent une action. [Détails](actions.md#propager-des-actions-dans-les-composants)
188188

189-
The first argument can optionally be a namespace string. [Details](modules.md#binding-helpers-with-namespace)
189+
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)
190190
191191
- **`mapMutations(namespace?: string, map: Array<string> | Object): Object`**
192192
193-
Create component methods options that commit a mutation. [Details](mutations.md#commiting-mutations-in-components)
193+
Créer des méthodes de composant qui actent une mutation. [Détails](mutations.md#acter-des-mutations-dans-les-composants)
194194
195-
The first argument can optionally be a namespace string. [Details](modules.md#binding-helpers-with-namespace)
195+
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)

0 commit comments

Comments
 (0)