IDBKeyRange.bound()

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 bound(), rattachée à l'interface IDBKeyRange, renvoie un intervalle de clé délimité par une borne inférieure et une borne supérieure.

L'intervalle peut être ouvert (les limites sont exclues) ou fermé (les limites sont incluses). Par défaut, l'intervalle est fermé.

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

Syntaxe

js
myKeyRange = IDBKeyRange.bound(lower, upper, lowerOpen, upperOpen);

Paramètres

lower

La limite inférieure de l'intervalle.

upper

La limite supérieure de l'intervalle.

lowerOpen Facultatif

Si cette valeur vaut false (la valeur par defaut), l'intervalle contient la limite inférieure.

upperOpen Facultatif

Si cette valeur vaut false (la valeur par défaut), l'intervalle contient la limite supérieure.

Valeur de retour

Un objet IDBKeyRange qui représente l'intervalle de clé.

Exceptions

DataError

Cette exception DOMException est levée si :

  • Une des limites passé n'est pas valide.
  • La limite inférieur est supèrieur à la limite supérieur.
  • Les limites correspondent et l'intervalle est ouvert.

Exemples

Dans l'exemple qui suit, on illustre comment créer un intervalle de clé. On déclare keyRangeValue = IDBKeyRange.bound("A", "F"); ce qui représente un intervalle entre "A" et "F". Ensuite, on ouvre une transaction grâce à un objet IDBTransaction puis on ouvre un magasin d'objets et on ouvre un curseur avec la méthode IDBObjectStore.openCursor pour lequel on indique keyRangeValue comme intervalle de clé correspondant. Cela signifie que le curseur ne parcourera que les enregistrements dont les clés sont contenues dans cet intervalle. L'intervalle contient bien les valeurs "A" et "F" car les bornes sont incluses. Si on avait utilisé IDBKeyRange.bound("A", "F", true, true);, l'intervalle n'aurait pas inclus "A" et "F" mais uniquement les valeurs intermédiaires.

js
function displayData() {
  var keyRangeValue = IDBKeyRange.bound("A", "F");

  var transaction = db.transaction(["fThings"], "readonly");
  var objectStore = transaction.objectStore("fThings");

  objectStore.openCursor(keyRangeValue).onsuccess = function (event) {
    var cursor = event.target.result;
    if (cursor) {
      var listItem = document.createElement("li");
      listItem.innerHTML =
        "<strong>" + cursor.value.fThing + "</strong>, " + cursor.value.fRating;
      list.appendChild(listItem);

      cursor.continue();
    } else {
      console.log("Les éléments ont été affichés.");
    }
  };
}

Note : Pour un exemple complet qui utilise les intervalles de clé, vous pouvez consulter le dépôt GitHub IDBKeyRange-example (ainsi que la démonstration associée).

Spécifications

Specification
Indexed Database API 3.0
# ref-for-dom-idbkeyrange-bound①

Compatibilité des navigateurs

BCD tables only load in the browser

Voir aussi