soil-query-core/soil.query/QueryKey

QueryKey

interface QueryKey<T>

QueryKey for managing Query associated with id.

Parameters

T

Type of data to retrieve.

Properties

contentCacheable

open val contentCacheable: QueryContentCacheable<T>?

Function to determine if the data should be cached.

open val contentEquals: QueryContentEquals<T>?

Function to compare the content of the data.

abstract val fetch: suspend QueryReceiver.() -> T

Suspending function to retrieve data.

abstract val id: QueryId<T>

A unique identifier used for managing QueryKey.

Functions

onConfigureOptions

open fun onConfigureOptions(): QueryOptionsOverride?

Function to configure the QueryOptions.

open fun onInitialData(): QueryInitialData<T>?

Function to specify initial data.

open fun onRecoverData(): QueryRecoverData<T>?

Function to convert specific exceptions as data.