IDBCursorWithValue

The IDBCursorWithValue interface of the IndexedDB API represents a cursor for traversing or iterating over multiple records in a database.

MDN Reference

Properties

Link copied to clipboard

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).

Link copied to clipboard

The key read-only property of the IDBCursor interface returns the key for the record at the cursor's position.

Link copied to clipboard

The primaryKey read-only property of the IDBCursor interface returns the cursor's current effective key.

Link copied to clipboard

The request read-only property of the IDBCursor interface returns the IDBRequest used to obtain the cursor.

Link copied to clipboard

The source read-only property of the IDBCursor interface returns the IDBObjectStore or IDBIndex that the cursor is iterating over.

Link copied to clipboard
val value: JsAny?

The value read-only property of the IDBCursorWithValue interface returns the value of the current cursor, whatever that is.

Functions

Link copied to clipboard
fun advance(count: Int)

The advance() method of the IDBCursor interface sets the number of times a cursor should move its position forward.

Link copied to clipboard
fun continue(key: IDBValidKey = definedExternally)

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.