Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Latest
interface IDBKeyRange
import { type IDBKeyRange } from "https://deno.land/x/indexeddb@1.3.5/ponyfill_memory.ts";

A key range can be a single value or a range with upper and lower bounds or endpoints. If the key range has both upper and lower bounds, then it is bounded; if it has no bounds, it is unbounded. A bounded key range can either be open (the endpoints are excluded) or closed (the endpoints are included). To retrieve all keys within a certain range, you can use the following code constructs:

Properties

readonly
lower: any

Returns lower bound, or undefined if none.

readonly
lowerOpen: boolean

Returns true if the lower open flag is set, and false otherwise.

readonly
upper: any

Returns upper bound, or undefined if none.

readonly
upperOpen: boolean

Returns true if the upper open flag is set, and false otherwise.

prototype: IDBKeyRange

Methods

includes(key: any): boolean

Returns true if key is included in the range, and false otherwise.

bound(
lower: any,
upper: any,
lowerOpen?: boolean,
upperOpen?: boolean,
): IDBKeyRange

Returns a new IDBKeyRange spanning from lower to upper. If lowerOpen is true, lower is not included in the range. If upperOpen is true, upper is not included in the range.

lowerBound(lower: any, open?: boolean): IDBKeyRange

Returns a new IDBKeyRange starting at key with no upper bound. If open is true, key is not included in the range.

only(value: any): IDBKeyRange

Returns a new IDBKeyRange spanning only key.

upperBound(upper: any, open?: boolean): IDBKeyRange

Returns a new IDBKeyRange with no lower bound and ending at key. If open is true, key is not included in the range.

variable IDBKeyRange
import { IDBKeyRange } from "https://deno.land/x/indexeddb@1.3.5/ponyfill_memory.ts";