Firefox Tomorrow

web api instance method

IDBKeyRange: includes() method

View on MDN ↗

Available in 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

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.

See also