IDBKeyRange: bound() static method

{{ APIRef("IndexedDB") }} {{AvailableInWorkers}}

The bound() static method of the {{domxref("IDBKeyRange")}} interface creates a new key range with the specified upper and lower bounds. The bounds can be open (that is, the bounds exclude the endpoint values) or closed (that is, the bounds include the endpoint values). By default, the bounds are closed.

Syntax

IDBKeyRange.bound(lower, upper)
IDBKeyRange.bound(lower, upper, lowerOpen)
IDBKeyRange.bound(lower, upper, lowerOpen, upperOpen)

Parameters

• lower
  • : specifies the lower bound of the new key range.
• upper
  • : specifies the upper bound of the new key range.
• lowerOpen {{optional_inline}}
  • : indicates whether the lower bound excludes the endpoint value. The default is false.
• upperOpen {{optional_inline}}
  • : Indicates whether the upper bound excludes the endpoint value. The default is false.

Return value

{{domxref("IDBKeyRange")}}: The newly created key range.

Exceptions

• DataError {{domxref("DOMException")}}
  • : Thrown when one of the following conditions is met:
    • The lower or upper parameters were not passed a valid key.
    • The lower key is greater than the upper key.
    • The lower key and upper key match and either of the bounds are open.

Examples

The following example illustrates how you'd use a bound key range. Here we declare a keyRangeValue = IDBKeyRange.bound("A", "F"); — a range between values of "A" and "F". We open a transaction (using {{domxref("IDBTransaction")}}) and an object store, and open a Cursor with {{domxref("IDBObjectStore.openCursor")}}, declaring keyRangeValue as its optional key range value. This means that the cursor will only retrieve records with keys inside that range. This range includes the values "A" and "F", as we haven't declared that they should be open bounds. If we used IDBKeyRange.bound("A", "F", true, true);, then the range would not include "A" and "F", only the values between them.

[!NOTE] For a more complete example allowing you to experiment with key range, have a look at the idbkeyrange directory in the indexeddb-examples repo. (View the example live too.

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

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

  objectStore.openCursor(keyRangeValue).onsuccess = (event) => {
    const cursor = event.target.result;
    if (cursor) {
      const listItem = document.createElement("li");
      listItem.textContent = `${cursor.value.fThing}, ${cursor.value.fRating}`;
      list.appendChild(listItem);

      cursor.continue();
    } else {
      console.log("Entries all displayed.");
    }
  };
}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• Using IndexedDB
• Starting transactions: {{domxref("IDBDatabase")}}
• Using transactions: {{domxref("IDBTransaction")}}
• Setting a range of keys: {{domxref("IDBKeyRange")}}
• Retrieving and making changes to your data: {{domxref("IDBObjectStore")}}
• Using cursors: {{domxref("IDBCursor")}}
• Reference example: To-do Notifications (View the example live).