soil-query-compose/soil.query.compose.util

Package-level declarations

Types

Link copied to clipboard
typealias QueriesErrorReset = () -> Unit

Properties

Link copied to clipboard
@get:Composable
val Namespace.Companion.autoCompositionKeyHash: Namespace

Automatically generated value for mutationId and subscriptionId.

Functions

Link copied to clipboard
@Composable
fun Namespace.Companion.auto(): Namespace

Automatically generated value for mutationId and subscriptionId.

Link copied to clipboard
@Composable
fun KeepAlive(key: InfiniteQueryKey<*, *>, client: QueryClient = LocalQueryClient.current)

Keep the infinite query alive.

@Composable
fun KeepAlive(key: MutationKey<*, *>, client: MutationClient = LocalMutationClient.current)

Keep the mutation alive.

@Composable
fun KeepAlive(key: QueryKey<*>, client: QueryClient = LocalQueryClient.current)

Keep the query alive.

Link copied to clipboard
@Composable
inline fun <T> MutatedEffect(mutation: MutationObject<T, *>, noinline block: suspend (data: T) -> Unit)
@Composable
fun <T, U : Any> MutatedEffect(mutation: MutationObject<T, *>, keySelector: (MutationSuccessObject<T, *>) -> U, keySaver: Saver<U?, out Any> = autoSaver(), block: suspend (data: T) -> Unit)

A Composable function to trigger side effects when a Mutation is successfully processed.

Link copied to clipboard
@Composable
fun rememberQueriesErrorReset(filter: ResumeQueriesFilter = remember { ResumeQueriesFilter(predicate = { it.isFailure }) }, client: SwrClient = LocalSwrClient.current): QueriesErrorReset

Remember a QueriesErrorReset to resume all queries with filter matched.