IDBIndex extension type

IDBIndex interface of the IndexedDB API provides asynchronous access to an index in a database. An index is a kind of object store for looking up records in another object store, called the referenced object store. You use this interface to retrieve data.

You can retrieve records in an object store through the primary key or by using an index. An index lets you look up records in an object store using properties of the values in the object stores records other than the primary key

The index is a persistent key-value storage where the value part of its records is the key part of a record in the referenced object store. The records in an index are automatically populated whenever records in the referenced object store are inserted, updated, or deleted. Each record in an index can point to only one record in its referenced object store, but several indexes can reference the same object store. When the object store changes, all indexes that refers to the object store are automatically updated.

You can grab a set of keys within a range. To learn more, see IDBKeyRange.

API documentation sourced from MDN Web Docs.

on

JSObject

Implemented types

JSObject

Available extensions

Properties

hashCode → int: The hash code for this object.
no setterinherited
isDefinedAndNotNull → bool: Available on JSAny?, provided by the NullableUndefineableJSAnyExtension extension

no setter
isNull → bool: Available on JSAny?, provided by the NullableUndefineableJSAnyExtension extension
Whether this value corresponds to JavaScript null.
no setter
isTruthy → JSBoolean: Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of !!this in JavaScript.
no setter
isUndefined → bool: Available on JSAny?, provided by the NullableUndefineableJSAnyExtension extension
Whether this value corresponds to JavaScript undefined.
no setter
isUndefinedOrNull → bool: Available on JSAny?, provided by the NullableUndefineableJSAnyExtension extension

no setter
keyPath → JSAny?: The keyPath property of the IDBIndex interface returns the key path of the current index. If null, this index is not auto-populated.
no setter
multiEntry → bool: The multiEntry read-only property of the IDBIndex interface returns a boolean value that affects how the index behaves when the result of evaluating the index's key path yields an array.
no setter
name ↔ String: The name property of the IDBIndex interface contains a string which names the index.
getter/setter pair
not → JSBoolean: Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of !this in JavaScript.
no setter
objectStore → IDBObjectStore: The objectStore property of the IDBIndex interface returns the object store referenced by the current index.
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
unique → bool: The unique read-only property returns a boolean that states whether the index allows duplicate keys.
no setter

Methods

add(JSAny? any) → JSAny: Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of this + any in JavaScript.
and(JSAny? any) → JSAny?: Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of this && any in JavaScript.
callMethod<R extends JSAny?>(JSAny method, [JSAny? arg1, JSAny? arg2, JSAny? arg3, JSAny? arg4]) → R: Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension
Calls method on this JSObject with up to four arguments.
callMethodVarArgs<R extends JSAny?>(JSAny method, [List<JSAny?>? arguments]) → R: Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension
Calls method on this JSObject with a variable number of arguments.
count([JSAny? query]) → IDBRequest: The count() method of the IDBIndex interface returns an IDBRequest object, and in a separate thread, returns the number of records within a key range.
dartify() → Object?: Available on JSAny?, provided by the JSAnyUtilityExtension extension
Converts a JavaScript value to the Dart equivalent if possible.
delete(JSAny property) → JSBoolean: Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension
Deletes the property with key property from this JSObject.
divide(JSAny? any) → JSAny: Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of this / any in JavaScript.
equals(JSAny? any) → JSBoolean: Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of this == any in JavaScript.
exponentiate(JSAny? any) → JSAny: Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of this ** any in JavaScript.
get(JSAny? query) → IDBRequest: The get() method of the IDBIndex interface returns an IDBRequest object, and, in a separate thread, finds either the value in the referenced object store that corresponds to the given key or the first corresponding value, if key is set to an IDBKeyRange.
getAll([JSAny? query, int count]) → IDBRequest: The getAll() method of the IDBIndex interface retrieves all objects that are inside the index.
getAllKeys([JSAny? query, int count]) → IDBRequest: The getAllKeys() method of the IDBIndex interface asynchronously retrieves the primary keys of all objects inside the index, setting them as the result of the request object.
getKey(JSAny? query) → IDBRequest: The getKey() method of the IDBIndex interface returns an IDBRequest object, and, in a separate thread, finds either the primary key that corresponds to the given key in this index or the first corresponding primary key, if key is set to an IDBKeyRange.
getProperty<R extends JSAny?>(JSAny property) → R: Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension
The value of the property key property of this JSObject.
greaterThan(JSAny? any) → JSBoolean: Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of this > any in JavaScript.
greaterThanOrEqualTo(JSAny? any) → JSBoolean: Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of this >= any in JavaScript.
has(String property) → bool: Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension
Shorthand helper for hasProperty to check whether this JSObject contains the property key property, but takes and returns a Dart value.
hasProperty(JSAny property) → JSBoolean: Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension
Whether or not this JSObject contains the property key property.
instanceof(JSFunction constructor) → bool: Available on JSAny?, provided by the JSAnyUtilityExtension extension
Whether this JSAny? is an instanceof constructor.
instanceOfString(String constructorName) → bool: Available on JSAny?, provided by the JSAnyUtilityExtension extension
Whether this JSAny? is an instanceof the constructor that is defined by constructorName, which is looked up in the globalContext.
isA<T extends JSAny?>() → bool: Available on JSAny?, provided by the JSAnyUtilityExtension extension
Whether this JSAny? is an instance of the JavaScript type that is declared by T.
lessThan(JSAny? any) → JSBoolean: Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of this < any in JavaScript.
lessThanOrEqualTo(JSAny? any) → JSBoolean: Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of this <= any in JavaScript.
modulo(JSAny? any) → JSAny: Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of this % any in JavaScript.
multiply(JSAny? any) → JSAny: Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of this * any in JavaScript.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
notEquals(JSAny? any) → JSBoolean: Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of this != any in JavaScript.
openCursor([JSAny? query, IDBCursorDirection direction]) → IDBRequest: The openCursor() method of the IDBIndex interface returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range.
openKeyCursor([JSAny? query, IDBCursorDirection direction]) → IDBRequest: The openKeyCursor() method of the IDBIndex interface returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range, as arranged by this index.
or(JSAny? any) → JSAny?: Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of this || any in JavaScript.
setProperty(JSAny property, JSAny? value) → void: Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension
Write the value of property key property of this JSObject.
strictEquals(JSAny? any) → JSBoolean: Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of this === any in JavaScript.
strictNotEquals(JSAny? any) → JSBoolean: Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of this !== any in JavaScript.
subtract(JSAny? any) → JSAny: Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of this - any in JavaScript.
toString() → String: A string representation of this object.
inherited
typeofEquals(String typeString) → bool: Available on JSAny?, provided by the JSAnyUtilityExtension extension
Whether the result of typeof on this JSAny? is typeString.
unsignedRightShift(JSAny? any) → JSNumber: Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of this >>> any in JavaScript.

Operators

operator ==(Object other) → bool: The equality operator.
inherited
operator [](String property) → JSAny?: Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension
Shorthand helper for getProperty to get the value of the property key property of this JSObject, but takes and returns a Dart value.
operator []=(String property, JSAny? value) → void: Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension
Shorthand helper for setProperty to write the value of the property key property of this JSObject, but takes a Dart value.

IDBIndex extension type

Properties

Methods

Operators

ui library