W3cubDocs

/Web APIs

IDBKeyRange: includes() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since ⁨January 2020⁩.

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

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

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

	Desktop					Mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on IOS	Samsung Internet	WebView Android	WebView on iOS
`includes`	52	79	47	39	10.1	52	47	41	10.3	6.0	52	10.3