IDBKeyRange: includes() method

The includes() method of the IDBKeyRange interface returns a boolean indicating whether a specified key is inside the key range.

Note: This feature is available in Web Workers

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