Package-level declarations

Types

Link copied to clipboard
open external class IDBCursor

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

Link copied to clipboard
sealed external interface IDBCursorDirection
Link copied to clipboard
external class IDBCursorWithValue : IDBCursor

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.

Link copied to clipboard
external class IDBDatabase : EventTarget

This IndexedDB API interface 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
external interface IDBDatabaseInfo
Link copied to clipboard
external class IDBFactory

In the following code snippet, we make a request to open a database, and include handlers for the success and error cases. For a full working example, see our To-do Notifications app (view example live.)

Link copied to clipboard
external 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
external interface IDBIndexParameters
Link copied to clipboard
external class IDBKeyRange

A key range can be a single value or a range with upper and lower bounds or endpoints. If the key range has both upper and lower bounds, then it is bounded; if it has no bounds, it is unbounded. A bounded key range can either be open (the endpoints are excluded) or closed (the endpoints are included). To retrieve all keys within a certain range, you can use the following code constructs:

Link copied to clipboard
external class IDBObjectStore

This example shows a variety of different uses of object stores, from updating the data structure with IDBObjectStore.createIndex inside an onupgradeneeded function, to adding a new item to our object store with IDBObjectStore.add. For a full working example, see our To-do Notifications app (view example live.)

Link copied to clipboard
external interface IDBObjectStoreParameters
Link copied to clipboard

Also inherits methods from its parents IDBRequest and EventTarget.

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

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.

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

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

Link copied to clipboard

Properties

Link copied to clipboard

Functions

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