aboutsummaryrefslogtreecommitdiff
path: root/files/fr/web/api/idbobjectstore/getkey/index.md
blob: a9afc0378f9ee49730ece4478f23a6c48e5ce5b7 (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
---
title: IDBObjectStore.getKey()
slug: Web/API/IDBObjectStore/getKey
tags:
  - IBDObjectStore
  - IndexedDB
  - Method
  - Méthode
  - Reference
  - Storage
  - Web API
translation_of: Web/API/IDBObjectStore/getKey
---
{{APIRef("IndexedDB")}}

La méthode **`getKey()`** de l'interface {{domxref("IDBObjectStore")}} retourne un objet {{domxref("IDBRequest")}}, et, dans un _thread_ séparé, retourne la clé sélectionnée par la requête spécifiée. Cela permet de retrouver un enregistrement spécifique depuis un espace de stockage déterminé.

Si la clé a bien été retrouvée, alors un clone structuré (une copie conforme) sera créée et servira comme résultat à l'objet de requête.

{{AvailableInWorkers}}

## Syntaxe

    let request = objectStore.getKey(key);

### Paramètres

- _key_
  - : La clé ou l'intervale de clé qui identifie l'enregistrement à retrouver.

### Valeur de retour

Un objet {{domxref("IDBRequest")}} sur lequel les événements ultérieurs liés à cette opération sont déclenchés.

### Exceptions

Cette méthode peut provoquer une {{domxref("DOMException")}} de l'un des types suivants :

| Exception                  | Description                                                                 |
| -------------------------- | --------------------------------------------------------------------------- |
| `TransactionInactiveError` | La transaction de ce {{domxref("IDBObjectStore")}} est inactive. |
| `DataError`                | La clé ou la plage de clés fournie contient une clé invalide.               |
| `InvalidStateError`        | Le {{domxref("IDBObjectStore")}} a été supprimé ou retiré.       |

## Exemple

```js
let openRequest = indexedDB.open("telemetry");
openRequest.onsuccess = (event) => {
  let db = event.target.result;
  let store = db.transaction("netlogs").objectStore("netlogs");

  let today = new Date();
  let yesterday = new Date(today);
  yesterday.setDate(today.getDate() - 1);
  let request = store.getKey(IDBKeyRange(yesterday, today));
  request.onsuccess = (event) => {
    let when = event.target.result;
    alert("La 1ère activité des dernières 24 heures s'est produite à " + when);
  };
};
```

## Spécifications

| Spécification                                                                                | Statut                           | Commentaire          |
| -------------------------------------------------------------------------------------------- | -------------------------------- | -------------------- |
| {{SpecName('IndexedDB 2', '#dom-idbobjectstore-getkey', 'getKey()')}} | {{Spec2('IndexedDB 2')}} | Définition initiale. |

## Compatibilité des navigateurs

{{Compat("api.IDBObjectStore.getKey")}}

## Voir aussi

- [Utiliser IndexedDB](/fr/docs/Web/API/IndexedDB_API/Using_IndexedDB)
- Transactions de départ : {{domxref("IDBDatabase")}}
- Utilisation des transactions : {{domxref("IDBTransaction")}}
- Réglage d'une fourchette de clés : {{domxref("IDBKeyRange")}}
- Récupération et modification de vos données : {{domxref("IDBObjectStore")}}
- Utilisation des curseurs : {{domxref("IDBCursor")}}
- Exemple de référence : [Notifications des tâches](https://github.com/mdn/to-do-notifications/tree/gh-pages) ([voir l'exemple en direct](https://mdn.github.io/to-do-notifications/).)