IDBObjectStore.getKey()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2021.

La méthode getKey() de l'interface IDBObjectStore retourne un objet 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.

Note : Cette fonctionnalité est disponible via les Web Workers.

Syntaxe

js
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 IDBRequest sur lequel les événements ultérieurs liés à cette opération sont déclenchés.

Exceptions

Cette méthode peut provoquer une DOMException de l'un des types suivants :

Exception Description
TransactionInactiveError La transaction de ce IDBObjectStore est inactive.
DataError La clé ou la plage de clés fournie contient une clé invalide.
InvalidStateError Le 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

Specification
Indexed Database API 3.0
# ref-for-dom-idbobjectstore-getkey①

Compatibilité des navigateurs

BCD tables only load in the browser

Voir aussi