Package-level declarations

Types

Link copied to clipboard
open class IDBCursor

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

Link copied to clipboard
sealed interface IDBCursorDirection
Link copied to clipboard

The IDBCursorWithValue interface of the IndexedDB API 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.

Link copied to clipboard

The IDBDatabase interface of the IndexedDB API provides a connection to a database; you can use an IDBDatabase object to open a transaction on your database then create, manipulate, and delete objects (data) in that database. The interface provides the only way to get and manage versions of the database.

Link copied to clipboard
interface IDBDatabaseInfo
Link copied to clipboard
open class IDBFactory

The IDBFactory interface of the IndexedDB API lets applications asynchronously access the indexed databases. The object that implements the interface is window.indexedDB. You open — that is, create and access — and delete a database with this object, and not directly with IDBFactory.

Link copied to clipboard
open class IDBIndex

IDBIndex interface of the IndexedDB API provides asynchronous access to an index in a database. An index is a kind of object store for looking up records in another object store, called the referenced object store. You use this interface to retrieve data.

Link copied to clipboard
Link copied to clipboard
open class IDBKeyRange

The IDBKeyRange interface of the IndexedDB API represents a continuous interval over some data type that is used for keys. Records can be retrieved from IDBObjectStore and IDBIndex objects using keys or a range of keys. You can limit the range using lower and upper bounds. For example, you can iterate over all values of a key in the value range A–Z.

Link copied to clipboard
open class IDBObjectStore

The IDBObjectStore interface of the IndexedDB API represents an object store in a database. Records within an object store are sorted according to their keys. This sorting enables fast insertion, look-up, and ordered retrieval.

Link copied to clipboard
Link copied to clipboard

The IDBOpenDBRequest interface of the IndexedDB API provides access to the results of requests to open or delete databases (performed using IDBFactory.open and IDBFactory.deleteDatabase), using specific event handler attributes.

Link copied to clipboard
open class IDBRequest<T : JsAny?> : EventTarget

The IDBRequest interface of the IndexedDB API provides access to results of asynchronous requests to databases and database objects using event handler attributes. Each reading and writing operation on a database is done using a request.

Link copied to clipboard
sealed interface IDBRequestReadyState
Link copied to clipboard

The IDBTransaction interface of the IndexedDB API provides a static, asynchronous transaction on a database using event handler attributes. All reading and writing of data is done within transactions. You use IDBDatabase to start transactions, IDBTransaction to set the mode of the transaction (e.g., is it readonly or readwrite), and you access an IDBObjectStore to make a request. You can also use an IDBTransaction object to abort transactions.

Link copied to clipboard
sealed interface IDBTransactionDurability
Link copied to clipboard
sealed interface IDBTransactionMode
Link copied to clipboard
Link copied to clipboard
sealed interface IDBValidKey
Link copied to clipboard
open class IDBVersionChangeEvent(val type: EventType<IDBVersionChangeEvent>, init: IDBVersionChangeEventInit = definedExternally) : Event

The IDBVersionChangeEvent interface of the IndexedDB API indicates that the version of the database has changed, as the result of an onupgradeneeded event handler function.

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard

The databases method of the IDBFactory interface returns a Promise that fulfills with an array of objects containing the name and version of all the available databases.

Link copied to clipboard
inline fun IDBValidKey(value: Date): IDBValidKey
inline fun IDBValidKey(value: Int): IDBValidKey
inline fun IDBValidKey(value: String): IDBValidKey