The only()
static method of the IDBKeyRange
interface creates a new key range containing a single value.
Note: This feature is available in Web Workers
The only()
static method of the IDBKeyRange
interface creates a new key range containing a single value.
Note: This feature is available in Web Workers
js
IDBKeyRange.only(value)
value
The value for the new key range.
IDBKeyRange
: The newly created key range.
DataError
DOMException
Thrown if the value
parameter was not a valid key.
The following example illustrates how you'd use an only key range. Here we declare a keyRangeValue = IDBKeyRange.only("A");
— a range that only includes the value "A". We open a transaction (using IDBTransaction
) and an object store, and open a Cursor with IDBObjectStore.openCursor
, declaring keyRangeValue
as its optional key range value. This means that the cursor will only retrieve the record with the key value "A".
Note: For a more complete example allowing you to experiment with key range, have a look at our IDBKeyRange repo (view the example live too.)
js
function displayData() { const keyRangeValue = IDBKeyRange.only("A"); 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."); } }; }
Specification |
---|
Indexed Database API 3.0 # ref-for-dom-idbkeyrange-only① |
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
only_static |
23 | 12 | 10 | 10 | 15 | 8 | 4.4 | 25 | 22 | 14 | 8 | 1.5 |
IDBDatabase
IDBTransaction
IDBKeyRange
IDBObjectStore
IDBCursor
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/IDBKeyRange/only_static