IDBTransaction

class IDBTransaction : EventTarget(source)

The IDBTransaction interface of the IndexedDB API provides a static, asynchronous transaction on a database using event handler attributes.

MDN Reference

Properties

abortEvent

val abortEvent: EventInstance<Event, IDBTransaction, IDBDatabase>

MDN Reference

completeEvent

val completeEvent: EventInstance<Event, IDBTransaction, IDBTransaction>

MDN Reference

val db: IDBDatabase

Returns the transaction's connection.

durability

val durability: IDBTransactionDurability

MDN Reference

error

val error: DOMException?

If the transaction was aborted, returns the error (a DOMException) providing the reason.

errorEvent

val errorEvent: EventInstance<Event, IDBTransaction, IDBTransaction>

MDN Reference

mode

val mode: IDBTransactionMode

Returns the mode the transaction was created with ("readonly" or "readwrite"), or "versionchange" for an upgrade transaction.

objectStoreNames

val objectStoreNames: DOMStringList

Returns a list of the names of object stores in the transaction's scope. For an upgrade transaction this is all object stores in the database.

onabort

var onabort: EventHandler<Event, IDBTransaction, IDBDatabase>?

MDN Reference

oncomplete

var oncomplete: EventHandler<Event, IDBTransaction, IDBTransaction>?

MDN Reference

onerror

var onerror: EventHandler<Event, IDBTransaction, IDBTransaction>?

MDN Reference

Functions

abort

fun abort()

Aborts the transaction. All pending requests will fail with a "AbortError" DOMException and all changes made to the database will be reverted.

commit

fun commit()

MDN Reference

dispatchEvent

fun dispatchEvent(event: Event): Boolean

objectStore

fun objectStore(name: String): IDBObjectStore

Returns an IDBObjectStore in the transaction's scope.

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>