IDBCursorWithValue extension type

The IDBCursorWithValue interface of the IndexedDB API represents a cursor for traversing or iterating over multiple records in a database. It is the same as the IDBCursor, except that it includes the value property.

The cursor has a source that indicates which index or object store it is iterating over. It has a position within the range, and moves in a direction that is increasing or decreasing in the order of record keys. The cursor enables an application to asynchronously process all the records in the cursor's range.

You can have an unlimited number of cursors at the same time. You always get the same IDBCursorWithValue object representing a given cursor. Operations are performed on the underlying index or object store.

API documentation sourced from MDN Web Docs.

on
Implemented types
Available extensions

Properties

direction → IDBCursorDirection
The direction read-only property of the IDBCursor interface is a string that returns the direction of traversal of the cursor (set using IDBObjectStore.openCursor for example). See the Values section below for possible values.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
key → JSAny?
The key read-only property of the IDBCursor interface returns the key for the record at the cursor's position. If the cursor is outside its range, this is set to undefined. The cursor's key can be any data type.
no setterinherited
primaryKey → JSAny?
The primaryKey read-only property of the IDBCursor interface returns the cursor's current effective key. If the cursor is currently being iterated or has iterated outside its range, this is set to undefined. The cursor's primary key can be any data type.
no setterinherited
request → IDBRequest
The request read-only property of the IDBCursor interface returns the IDBRequest used to obtain the cursor.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
source → JSObject
The source read-only property of the IDBCursor interface returns the IDBObjectStore or IDBIndex that the cursor is iterating over. This function never returns null or throws an exception, even if the cursor is currently being iterated, has iterated past its end, or its transaction is not active.
no setterinherited
value → JSAny?
The value read-only property of the IDBCursorWithValue interface returns the value of the current cursor, whatever that is.
no setter

Methods

advance(int count) → void
The advance() method of the IDBCursor interface sets the number of times a cursor should move its position forward.
inherited
continue_([JSAny? key]) → void
The continue() method of the IDBCursor interface advances the cursor to the next position along its direction, to the item whose key matches the optional key parameter. If no key is specified, the cursor advances to the immediate next position, based on its direction.
inherited
continuePrimaryKey(JSAny? key, JSAny? primaryKey) → void
The continuePrimaryKey() method of the IDBCursor interface advances the cursor to the item whose key matches the key parameter as well as whose primary key matches the primary key parameter.
inherited
delete() → IDBRequest
The delete() method of the IDBCursor interface returns an IDBRequest object, and, in a separate thread, deletes the record at the cursor's position, without changing the cursor's position. Once the record is deleted, the cursor's value is set to null.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
update(JSAny? value) → IDBRequest
The update() method of the IDBCursor interface returns an IDBRequest object, and, in a separate thread, updates the value at the current position of the cursor in the object store. If the cursor points to a record that has just been deleted, a new record is created.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited