aboutsummaryrefslogtreecommitdiff
path: root/files/fr/web/api/idbcursor/advance/index.md
blob: b3f7f674f987f7a849c0a2fec6f599805bf85603 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
---
title: IDBCursor.advance()
slug: Web/API/IDBCursor/advance
tags:
  - API
  - IndexedDB
  - Méthode
  - Reference
translation_of: Web/API/IDBCursor/advance
---
{{APIRef("IndexedDB")}}

La méthode **`advance()`** de l'interface {{domxref("IDBCursor")}} définit le nombre d'itérations du curseur avec lequel celui-ci doit se déplacer vers l'avant.

{{AvailableInWorkers}}

## Syntaxe

```js
cursor.advance(count);
```

### Paramètres

- `count`
  - : Le nombre d'itérations du curseur.

### Valeur de retour

Aucune.

### Exceptions

Cette méthode peut déclencher des exceptions  {{domxref("DOMException")}} :

| Exception                  | Description                                                      |
| -------------------------- | ---------------------------------------------------------------- |
| `TransactionInactiveError` | Cette transaction IDBCursor est inactive.                        |
| `TypeError`                | La valeur passée au paramètre `count` vaut zéro ou est négative. |
| `InvalidStateError`        | Le curseur est en itération ou a itéré au-delà de la plage.      |

## Exemple

Dans ce petit morceau de code on fait une transaction, récupère un magasin d'objet, puis utilise un curseur pour itérer sur les enregistrements du magasin. Ici, on utilise `cursor.advance(2)` pour avancer de 2 cases à chaque fois, ce qui signifie que seule la moitié des résultats sera affichée. `advance()`fonctionne de façon similaire à {{domxref ("IDBCursor.continue")}} mais permet de sauter plusieurs enregistrements à la fois et pas uniquement d'accéder à l'enregistrement suivant.

On notera également que, dans chaque itération de la boucle, on peut récupérer les données de l'enregistrement en cours grâce à l'objet curseur via `curseur.value.foo`. Pour un exemple fonctionnel complet, voir [notre exemple IDBCursor](https://github.com/mdn/IDBcursor-example/) ([l'exemple en _live_](https://mdn.github.io/IDBcursor-example/)).

```js
function advanceResult() {
  list.innerHTML = '';
  var transaction = db.transaction(['granListAlbum'], "readonly");
  var objectStore = transaction.objectStore('granListAlbum');

  objectStore.openCursor().onsuccess = function(event) {
    var curseur = event.target.result;
    if(curseur) {
      var listItem = document.createElement('li');
      listItem.innerHTML = '' + curseur.value.titreAlbum + ', ' + curseur.value.annee;
      list.appendChild(listItem);
      curseur.advance(2);
    } else {
      console.log('moitié des resultats affichée');
    }
  };
};
```

## Spécifications

| Spécification                                                                                                            | État                         | Commentaires |
| ------------------------------------------------------------------------------------------------------------------------ | ---------------------------- | ------------ |
| {{SpecName('IndexedDB', '#widl-IDBCursor-advance-void-unsigned-long-count', 'advance()')}} | {{Spec2('IndexedDB')}} |              |

## Compatibilité des navigateurs

{{Compat("api.IDBCursor.advance")}}

## Voir aussi

- [Manipuler IndexedDB](/fr/docs/Web/API/API_IndexedDB/Using_IndexedDB)
- Démarrer des transactions : {{domxref("IDBDatabase")}}
- Manipuler des transactions : {{domxref("IDBTransaction")}}
- Définir un intervalle de clés : {{domxref("IDBKeyRange")}}
- Récupérer des données et les modifier : {{domxref("IDBObjectStore")}}
- Manipuler des curseurs : {{domxref("IDBCursor")}}
- Exemple de référence pour IndexedDB : [To-do Notifications](https://github.com/mdn/to-do-notifications/tree/gh-pages)