View source

class KeyRange

package js.html.idb

@:native("IDBKeyRange")

Available on js

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:

Documentation IDBKeyRange by Mozilla Contributors, licensed under CC-BY-SA 2.5.

See also:

Static methods

@:value({ upperOpen : false, lowerOpen : false })staticbound(lower:Dynamic, upper:Dynamic, lowerOpen:Bool = false, upperOpen:Bool = false):KeyRange

Creates a new key range with upper and lower bounds.

Throws:

null

DOMError

@:value({ open : false })staticlowerBound(lower:Dynamic, open:Bool = false):KeyRange

Creates a new key range with only a lower bound.

Throws:

null

DOMError

staticonly(value:Dynamic):KeyRange

Creates a new key range containing a single value.

Throws:

null

DOMError

@:value({ open : false })staticupperBound(upper:Dynamic, open:Bool = false):KeyRange

Creates a new upper-bound key range.

Throws:

null

DOMError

Variables

read onlylower:Dynamic

Lower bound of the key range.

read onlylowerOpen:Bool

Returns false if the lower-bound value is included in the key range.

read onlyupper:Dynamic

Upper bound of the key range.

read onlyupperOpen:Bool

Returns false if the upper-bound value is included in the key range.

Methods

includes(key:Dynamic):Bool

Returns a boolean indicating whether a specified key is inside the key range.

Throws:

null

DOMError