kotlin-browser/web.idb/IDBCursorWithValue

IDBCursorWithValue

sealed external class IDBCursorWithValue : IDBCursor(source)

This IndexedDB API interface 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.

MDN Reference

Properties

direction

val direction: IDBCursorDirection

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

key

val key: IDBValidKey

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

primaryKey

val primaryKey: IDBValidKey

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

request

val request: IDBRequest<*>

MDN Reference

source

val source: Any

Returns the IDBObjectStore or IDBIndex the cursor was opened from.

value

val value: Any?

Returns the cursor's current value.

Functions

advance

fun advance(count: Int)

Advances the cursor through the next count records in range.

continue

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.

delete

fun delete(): IDBRequest<Void>

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

update

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

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