IDBRequest

sealed external class IDBRequest<T> : EventTarget(source)

The request object does not initially contain any information about the result of the operation, but once information becomes available, an event is fired on the request, and the information becomes available through the properties of the IDBRequest instance.

MDN Reference

Inheritors

IDBOpenDBRequest

Properties

error

val error: DOMException?

When a request is completed, returns the error (a DOMException), or null if the request succeeded. Throws a "InvalidStateError" DOMException if the request is still pending.

errorEvent

val errorEvent: EventInstance<Event, IDBRequest<T>, IDBTransaction>

MDN Reference

onerror

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

MDN Reference

onsuccess

var onsuccess: EventHandler<Event, IDBRequest<T>, IDBRequest<T>>?

MDN Reference

readyState

val readyState: IDBRequestReadyState

Returns "pending" until a request is complete, then returns "done".

result

val result: T

When a request is completed, returns the result, or undefined if the request failed. Throws a "InvalidStateError" DOMException if the request is still pending.

source

val source: Any

Returns the IDBObjectStore, IDBIndex, or IDBCursor the request was made against, or null if is was an open request.

successEvent

open val successEvent: EventInstance<Event, IDBRequest<T>, IDBRequest<T>>

MDN Reference

transaction

val transaction: IDBTransaction?

Returns the IDBTransaction the request was made within. If this as an open request, then it returns an upgrade transaction while it is running, or null otherwise.

Functions

dispatchEvent

fun dispatchEvent(event: Event): Boolean