History

class History<T>(maxSize: Int, initialValue: List<T>)

Keeps track of historical values (i.e. of a Store) and allows you to navigate back in history

Parameters

maxSize

history keeps at most this many last values

initialValue

initial content of the history

fun <T> History(maxSize: Int, initialValue: List<T>)

fun add(entry: T)

adds a new value to the history

fun back(): T

gets the last value that has been added and removes it from the history.

fun last(): T

gets the last value that has been added to the history. Leaves history unmodified.

fun reset()

clears the history.

fun sync(upstream: Store<T>): History<T>

syncs this history to a given store, so that each update is automatically stored in history.

Flow describing, if a value is available in the history

Represents the current entries in history.

val data: Flow<List<T>>

Gives a Flow with the entries of the history.