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:

https://developer.mozilla.org/en-US/docs/Web/API/IDBKeyRange

Variables

read only lower:Dynamic

Lower bound of the key range.

read only lowerOpen:Bool

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

read only upper:Dynamic

Upper bound of the key range.

read only upperOpen:Bool

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

Methods

includes (key:Dynamic):Bool

Throws:

null	DOMError

Static methods

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

Throws:

null	DOMError

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

Throws:

null	DOMError

static only (value:Dynamic):KeyRange

Throws:

null	DOMError

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

Throws:

null	DOMError