soil-query-test/soil.query.test

Package-level declarations

Types

typealias FakeInfiniteQueryFetch<T, S> = suspend (param: S) -> T

class FakeInfiniteQueryKey<T, S>(target: InfiniteQueryKey<T, S>, mock: FakeInfiniteQueryFetch<T, S>) : InfiniteQueryKey<T, S>

Creates a fake infinite query key that returns the result of the given mock function.

FakeMutationKey

class FakeMutationKey<T, S>(target: MutationKey<T, S>, mock: FakeMutationMutate<T, S>) : MutationKey<T, S>

Creates a fake mutation key that returns the result of the given mock function.

FakeMutationMutate

typealias FakeMutationMutate<T, S> = suspend (variable: S) -> T

FakeQueryFetch

typealias FakeQueryFetch<T> = suspend () -> T

FakeQueryKey

class FakeQueryKey<T>(target: QueryKey<T>, mock: FakeQueryFetch<T>) : QueryKey<T>

Creates a fake query key that returns the result of the given mock function.

FakeSubscriptionKey

class FakeSubscriptionKey<T>(target: SubscriptionKey<T>, mock: FakeSubscriptionSubscribe<T>) : SubscriptionKey<T>

Creates a fake subscription key that returns the result of the given mock function.

FakeSubscriptionSubscribe

typealias FakeSubscriptionSubscribe<T> = () -> Flow<T>

TestSwrClient

interface TestSwrClient : SwrClient

This extended interface of the SwrClient provides the capability to mock specific queries and mutations for the purpose of testing. By registering certain keys as mocks, you can control the behavior of these specific keys while the rest of the keys function normally. This allows for more targeted and precise testing of your application.

TestSwrClientPlus

interface TestSwrClientPlus : TestSwrClient, SwrClientPlus

This extended interface of the SwrClientPlus provides the capability to mock specific queries, mutations, and subscriptions for the purpose of testing. By registering certain keys as mocks, you can control the behavior of these specific keys while the rest of the keys function normally. This allows for more targeted and precise testing of your application.

Functions

test

fun SwrClient.test(initializer: TestSwrClient.() -> Unit = {}): TestSwrClient

Switches SwrClient to a test interface.

testPlus

fun SwrClientPlus.testPlus(initializer: TestSwrClientPlus.() -> Unit = {}): TestSwrClientPlus

Switches SwrClientPlus to a test interface.