The entry point to the library. Open documents on the default store with document, or open a named Collection with collection when a separate MMKV file is warranted.

DocumentsInitializer

class DocumentsInitializer : Initializer<Unit>

Bootstraps MMKV at process start so consumers never call MMKV.initialize themselves.

FieldDecorator

interface FieldDecorator

A bytes-in/bytes-out transform applied to one field's already-CBOR-encoded value.

Functions

document

inline fun <T> Collection.document(key: String, noinline config: DocumentConfig.() -> Unit = {}): Document<T>

Opens the Document at key in this collection, resolving the value type's serializer at the call site and configured through config.

inline fun <T> Documents.document(key: String, noinline config: DocumentConfig.() -> Unit = {}): Document<T>

Opens the Document at key on the default store, resolving the value type's serializer at the call site.

field

inline fun <V> Document<*>.field(prop: KProperty1<*, V>, default: V): ReadWriteProperty<Any?, V>

A property delegate backed by the single decomposed key for prop on this document.

fieldFlow

inline fun <V> Document<*>.fieldFlow(prop: KProperty1<*, V>, default: V): Flow<V>

A cold Flow of the value of the single field prop on this document.

update

inline fun <T, V> Document<T>.update(prop: KProperty1<T, V>, value: V)

Writes value directly to the single decomposed key for prop on this document, with no read of the rest of the document. Emits on the document's Document.flow.