5.0.0

oskit-kmp/com.outsidesource.oskitkmp.storage

Package-level declarations

Types

external class Error : JsAny

external class Event : JsAny

external class IDBDatabase : JsAny

external class IDBIndex : JsAny

external class IDBKeyRange : JsAny

external class IDBObjectStore : JsAny

IDBOpenDBRequest

external class IDBOpenDBRequest : JsAny

IDBOpenSuccessEvent

external interface IDBOpenSuccessEvent : JsAny

external class IDBRequest<T : JsAny?> : JsAny

IDBRequestEventTarget

external interface IDBRequestEventTarget : JsAny

external class IDBTransaction : JsAny

IDBVersionChangeEvent

external class IDBVersionChangeEvent : JsAny

interface IKmpKvStore

KmpKvStore is a multiplatform key value store that allows persistent storage of any data

IKmpKvStoreNode

interface IKmpKvStoreNode

external object indexedDB

IndexedDbClosedException

class IndexedDbClosedException : Exception

InMemoryKmpKvStore

class InMemoryKmpKvStore : IKmpKvStore

InMemoryKmpKvStoreNode

class InMemoryKmpKvStoreNode(name: String) : IKmpKvStoreNode

InMemoryKmpKvStoreNode provides a thread-safe, fallback, in-memory storage node

class KmpKvStoreNode : IKmpKvStoreNode

WasmKmpKvStoreType

enum WasmKmpKvStoreType : Enum<WasmKmpKvStoreType>

Functions

suspend fun <T : JsAny?> Outcome<IDBRequest<T>, Any>.await(): Outcome<T, Any>

suspend fun <T : JsAny?> IDBRequest<T>.await(): Outcome<T, Any>

suspend fun IDBOpenDBRequest.await(onUpgradeNeeded: (IDBDatabase, oldVersion: Int, newVersion: Int) -> Unit): Outcome<IDBDatabase, Any>

createObjectStoreOptions

fun createObjectStoreOptions(autoIncrement: Boolean): JsAny

fun createObjectStoreOptions(keyPath: String): JsAny

fun createObjectStoreOptions(keyPath: String, autoIncrement: Boolean): JsAny

fun KmpKvStore(appContext: Context): IKmpKvStore

fun KmpKvStore(): IKmpKvStore

fun KmpKvStore(appName: String): IKmpKvStore

fun KmpKvStore(type: WasmKmpKvStoreType = WasmKmpKvStoreType.IndexedDb): IKmpKvStore

inline suspend fun <T : JsAny?> IDBDatabase.suspendRequest(crossinline block: () -> IDBRequest<T>): Outcome<T, Any>

Helper functions