soil-query-compose/soil.query.compose.tooling/SwrPreviewClient

SwrPreviewClient

class SwrPreviewClient(query: QueryPreviewClient = QueryPreviewClient(emptyMap()), mutation: MutationPreviewClient = MutationPreviewClient(emptyMap()), subscription: SubscriptionPreviewClient = SubscriptionPreviewClient(emptyMap()), val errorRelay: Flow<ErrorRecord> = flow { }) : SwrClient, SwrClientPlus, QueryClient, MutationClient, SubscriptionClient

Provides the ability to preview specific queries and mutations for composable previews.

val client = SwrPreviewClient(..)
SwrClientProvider(client = client) {
  // Composable previews
}

Constructors

SwrPreviewClient

constructor(query: QueryPreviewClient = QueryPreviewClient(emptyMap()), mutation: MutationPreviewClient = MutationPreviewClient(emptyMap()), subscription: SubscriptionPreviewClient = SubscriptionPreviewClient(emptyMap()), errorRelay: Flow<ErrorRecord> = flow { })

Properties

defaultMutationOptions

open override val defaultMutationOptions: MutationOptions

defaultQueryOptions

open override val defaultQueryOptions: QueryOptions

defaultSubscriptionOptions

open override val defaultSubscriptionOptions: SubscriptionOptions

open override val errorRelay: Flow<ErrorRecord>

Functions

open override fun gc(level: MemoryPressureLevel)

getInfiniteQuery

open override fun <T, S> getInfiniteQuery(key: InfiniteQueryKey<T, S>, marker: Marker): InfiniteQueryRef<T, S>

open override fun <T, S> getMutation(key: MutationKey<T, S>, marker: Marker): MutationRef<T, S>

open override fun <T> getQuery(key: QueryKey<T>, marker: Marker): QueryRef<T>

getSubscription

open override fun <T> getSubscription(key: SubscriptionKey<T>, marker: Marker): SubscriptionRef<T>

open override fun onMount(id: String)

open override fun onUnmount(id: String)

open override fun perform(sideEffects: QueryEffect): Job

prefetchInfiniteQuery

open override fun <T, S> prefetchInfiniteQuery(key: InfiniteQueryKey<T, S>, marker: Marker): Job

open override fun <T> prefetchQuery(key: QueryKey<T>, marker: Marker): Job