kotlin-browser/web.idb/IDBCursor

IDBCursor

sealed external class IDBCursor(source)

This IndexedDB API interface represents a cursor for traversing or iterating over multiple records in a database.

Inheritors

IDBCursorWithValue

Properties

val direction: IDBCursorDirection

Returns the direction ("next", "nextunique", "prev" or "prevunique") of the cursor.

val key: IDBValidKey

Returns the key of the cursor. Throws a "InvalidStateError" DOMException if the cursor is advancing or is finished.

val primaryKey: IDBValidKey

Returns the effective key of the cursor. Throws a "InvalidStateError" DOMException if the cursor is advancing or is finished.

val request: IDBRequest<*>

val source: Any

Returns the IDBObjectStore or IDBIndex the cursor was opened from.

Functions

fun advance(count: Int)

Advances the cursor through the next count records in range.

fun continue(key: IDBValidKey = definedExternally)

Advances the cursor to the next record in range.

continuePrimaryKey

fun continuePrimaryKey(key: IDBValidKey, primaryKey: IDBValidKey)

Advances the cursor to the next record in range matching or after key and primaryKey. Throws an "InvalidAccessError" DOMException if the source is not an index.

fun delete(): IDBRequest<Void>

Delete the record pointed at by the cursor with a new value.

fun update(value: Any?): IDBRequest<IDBValidKey>

Updated the record pointed at by the cursor with a new value.