utils/dev.kindling.utils.state/KMap

KMap

class KMap<K, V>(initialEntries: List<Pair<K, V>> = emptyList())(source)

A reactive key-value map.

Port of the useMap React hook.

val map = KMap<String, Int>()
map.set("apples", 3)
map.set("bananas", 5)

println(map.get("apples"))  // 3
println(map.has("bananas")) // true

map.remove("apples")
map.clear()

// Observe reactively:
map.state.collect { snapshot -> render(snapshot) }

Parameters

initialEntries

Key-value pairs to pre-populate the map.

Constructors

constructor(initialEntries: List<Pair<K, V>> = emptyList())

Properties

val isEmpty: Boolean

true when the map contains no entries.

Number of entries currently in the map.

val snapshot: Map<K, V>

The current map snapshot.

val state: StateFlow<Map<K, V>>

Immutable snapshot of the current map contents as a StateFlow.

Functions

fun clear()

Removes all entries.

fun get(key: K): V?

Returns the value for key, or null if absent.

fun has(key: K): Boolean

Returns true when the map contains key.

fun remove(key: K)

Removes the entry for key. No-op if absent.

fun set(key: K, value: V)

Associates key with value, replacing any existing entry.

open override fun toString(): String