IDBKeyRange extension type
The IDBKeyRange
interface of the
IndexedDB API
represents a continuous interval over some data type that is used for keys.
Records can be retrieved from IDBObjectStore and IDBIndex objects using
keys or a range of keys. You can limit the range using lower and upper
bounds. For example, you can iterate over all values of a key in the value
range A–Z.
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:
Range | Code |
---|---|
All keys ≥ x | IDBKeyRange.lowerBound(x) |
All keys > x | IDBKeyRange.lowerBound(x, true) |
All keys ≤ y | IDBKeyRange.upperBound(y) |
All keys < y | IDBKeyRange.upperBound(y, true) |
All keys ≥ x && ≤ y | IDBKeyRange.bound(x, y) |
All keys > x &&< y | IDBKeyRange.bound(x, y, true, true) |
All keys > x && ≤ y | IDBKeyRange.bound(x, y, true, false) |
All keys ≥ x &&< y | IDBKeyRange.bound(x, y, false, true) |
The key = z | IDBKeyRange.only(z) |
A key is in a key range if the following conditions are true:
-
The lower value of the key range is one of the following:
undefined
- Less than key value
- Equal to key value if
lowerOpen
isfalse
.
-
The upper value of the key range is one of the following:
undefined
- Greater than key value
- Equal to key value if
upperOpen
isfalse
.
API documentation sourced from MDN Web Docs.
- on
- Implemented types
- Available extensions
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- lower → JSAny?
-
The
lower
read-only property of the IDBKeyRange interface returns the lower bound of the key range.no setter - lowerOpen → bool
-
The
lowerOpen
read-only property of the IDBKeyRange interface returns a boolean indicating whether the lower-bound value is included in the key range.no setter - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- upper → JSAny?
-
The
upper
read-only property of the IDBKeyRange interface returns the upper bound of the key range.no setter - upperOpen → bool
-
The
upperOpen
read-only property of the IDBKeyRange interface returns a boolean indicating whether the upper-bound value is included in the key range.no setter
Methods
-
includes(
JSAny? key) → bool -
The
includes()
method of the IDBKeyRange interface returns a boolean indicating whether a specified key is inside the key range. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
bound(
JSAny? lower, JSAny? upper, [bool lowerOpen, bool upperOpen]) → IDBKeyRange -
The
bound()
static method of the IDBKeyRange interface creates a new key range with the specified upper and lower bounds. The bounds can be open (that is, the bounds exclude the endpoint values) or closed (that is, the bounds include the endpoint values). By default, the bounds are closed. -
lowerBound(
JSAny? lower, [bool open]) → IDBKeyRange -
The
lowerBound()
static method of the IDBKeyRange interface creates a new key range with only a lower bound. By default, it includes the lower endpoint value and is closed. -
only(
JSAny? value) → IDBKeyRange -
The
only()
static method of the IDBKeyRange interface creates a new key range containing a single value. -
upperBound(
JSAny? upper, [bool open]) → IDBKeyRange -
The
upperBound()
static method of the IDBKeyRange interface creates a new upper-bound key range. By default, it includes the upper endpoint value and is closed.