IDBCursor

open class IDBCursor(source)

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

MDN Reference

Inheritors

Properties

Link copied to clipboard

The direction read-only property of the direction of traversal of the cursor (set using section below for possible values.

Link copied to clipboard

The key read-only property of the position.

Link copied to clipboard

The primaryKey read-only property of the cursor is currently being iterated or has iterated outside its range, this is set to undefined.

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 null or throws an exception, even if the cursor is currently being iterated, has iterated past its end, or its transaction is not active.

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