3.1.1

Cache/opensavvy.cache

Package-level declarations

Reactive key-value store algorithms represented by the Cache interface.

For convenience, adapters are provided:

cache caches calls to any suspend function,
batchingCache intercepts subsequent cache requests and batches them into a single larger request.

The following cache layers are available:

cachedInMemory stores results in-memory. When values are updated, it continues to show the old values while the new ones are being fetched,
expireAfter expires the values stored by the previous layer after some time has passed.

Types

interface Cache<Identifier, Failure, Value>

Stores information temporarily to avoid unneeded network requests.

ExperimentalCacheApi

annotation class ExperimentalCacheApi

InfallibleCache

typealias InfallibleCache<Identifier, Value> = Cache<Identifier, Nothing, Value>

Stores information temporarily to avoid unneeded network requests, with no error strategy.

Functions

fun <Identifier, Failure, Value> batchingCache(scope: CoroutineScope, workers: Int = 1, transform: suspend FlowCollector<Pair<Identifier, ProgressiveOutcome<Failure, Value>>>.(Set<Identifier>) -> Unit): Cache<Identifier, Failure, Value>

Cache implementation which collects cache requests into batches which are queried at the same time.

@JvmName(name = "infallibleCache")

fun <Identifier, Value> cache(transform: suspend (Identifier) -> Value): InfallibleCache<Identifier, Value>

fun <Identifier, Failure, Value> cache(transform: suspend (Identifier) -> Outcome<Failure, Value>): Cache<Identifier, Failure, Value>

Cache implementation which calls a given transform suspending function.

cachedInBrowserStorage

@ExperimentalCacheApi

fun <Identifier, Failure, Value : Any> Cache<Identifier, Failure, Value>.cachedInBrowserStorage(storage: Storage, keyPrefix: String, serializeIdentifier: (Identifier) -> String?, serializeValue: (Value) -> String?, deserializeValue: (String) -> Value?): Cache<Identifier, Failure, Value>

In-browser Cache layer.

cachedInLocalStorage

@ExperimentalCacheApi

fun <Identifier, Failure, Value : Any> Cache<Identifier, Failure, Value>.cachedInLocalStorage(keyPrefix: String, serializeIdentifier: (Identifier) -> String?, serializeValue: (Value) -> String?, deserializeValue: (String) -> Value?): Cache<Identifier, Failure, Value>

In-browser Cache implementation that is shared between tabs and persists when the browser is closed.

fun <Identifier, Failure, Value> Cache<Identifier, Failure, Value>.cachedInMemory(job: Job): Cache<Identifier, Failure, Value>

In-memory Cache layer.

cachedInSessionStorage

@ExperimentalCacheApi

fun <Identifier, Failure, Value : Any> Cache<Identifier, Failure, Value>.cachedInSessionStorage(keyPrefix: String, serializeIdentifier: (Identifier) -> String?, serializeValue: (Value) -> String?, deserializeValue: (String) -> Value?): Cache<Identifier, Failure, Value>

In-browser Cache implementation that is cleared when the tab is closed.

fun <Identifier, Failure, Value> Cache<Identifier, Failure, Value>.expireAfter(duration: Duration, scope: CoroutineScope, clock: Clock): Cache<Identifier, Failure, Value>

Age-based Cache expiration strategy.