IDBKeyRange: includes() method
Note: This feature is available in Web Workers.
The includes()
method of the IDBKeyRange
interface returns a boolean indicating whether a specified key is inside the key
range.
Syntax
js
includes(key)
Parameters
key
-
The key you want to check for in your key range. This can be any type.
Return value
A boolean value.
Exceptions
DataError
DOMException
-
Thrown if the supplied key was not a valid key.
Examples
js
const keyRangeValue = IDBKeyRange.bound("A", "K", false, false);
keyRangeValue.includes("F");
// Returns true
keyRangeValue.includes("W");
// Returns false
Specifications
Specification |
---|
Indexed Database API 3.0 # ref-for-dom-idbkeyrange-includes① |
Browser compatibility
BCD tables only load in the browser
See also
- Using IndexedDB
- Starting transactions:
IDBDatabase
- Using transactions:
IDBTransaction
- Setting a range of keys:
IDBKeyRange
- Retrieving and making changes to your data:
IDBObjectStore
- Using cursors:
IDBCursor
- Reference example: To-do Notifications (View the example live).