cacheonhand-compose/io.github.notoriouscorgi.cacheonhand.compose

Package-level declarations

Types

class ComposableFireAndForgetMutation<TInput : CacheableInput.MutationInput, TError : Throwable>(block: @Composable () -> RememberFireAndForgetMutationResult<TInput, TError>)

ComposableFireAndForgetMutationNoInput

class ComposableFireAndForgetMutationNoInput<TError : Throwable>(block: @Composable () -> RememberFireAndForgetMutationNoInputResult<TError>)

ComposableFlow

class ComposableFlow<TInput : CacheableInput.FlowInput, TData, TError : Throwable>(block: @Composable (input: TInput?, enabled: Boolean, launchImmediately: Boolean, onEachSuccess: suspend (data: TData) -> Unit?, onError: suspend (error: TError) -> Unit?) -> RememberFlowResult<TInput, TData, TError>)

ComposableFlowNoInput

class ComposableFlowNoInput<TData, TError : Throwable>(block: @Composable (enabled: Boolean, launchImmediately: Boolean, onEachSuccess: suspend (data: TData) -> Unit?, onError: suspend (error: TError) -> Unit?) -> RememberFlowNoInputResult<TData, TError>)

ComposableInfiniteQuery

class ComposableInfiniteQuery<TInput : CacheableInput.QueryInput, TPageParam, TData, TError : Throwable>(block: @Composable (input: TInput?, enabled: Boolean, launchImmediately: Boolean, onSuccess: suspend (pageData: PagedData<TPageParam?, TData>?) -> Unit?, onError: suspend (error: TError) -> Unit?) -> RememberInfiniteQueryResult<TInput, TPageParam, TData, TError>)

ComposableInfiniteQueryNoInput

class ComposableInfiniteQueryNoInput<TPageParam, TData, TError : Throwable>(block: @Composable (enabled: Boolean, launchImmediately: Boolean, onSuccess: suspend (pageData: PagedData<TPageParam?, TData>?) -> Unit?, onError: suspend (error: TError) -> Unit?) -> RememberInfiniteQueryNoInputResult<TPageParam, TData, TError>)

ComposableMutation

class ComposableMutation<TInput : CacheableInput.MutationInput, TData, TError : Throwable>(block: @Composable () -> RememberMutationResult<TInput, TData, TError>)

ComposableMutationNoInput

class ComposableMutationNoInput<TData, TError : Throwable>(block: @Composable () -> RememberMutationNoInputResult<TData, TError>)

ComposableQuery

class ComposableQuery<TInput : CacheableInput.QueryInput, TData, TError : Throwable>(block: @Composable (input: TInput?, enabled: Boolean, launchImmediately: Boolean, refetchInterval: Duration?, onSuccess: suspend (data: TData) -> Unit?, onError: suspend (error: TError) -> Unit?) -> RememberQueryResult<TInput, TData, TError>)

ComposableQueryNoInput

class ComposableQueryNoInput<TData, TError : Throwable>(block: @Composable (enabled: Boolean, launchImmediately: Boolean, refetchInterval: Duration?, onSuccess: suspend (data: TData) -> Unit?, onError: suspend (error: TError) -> Unit?) -> RememberQueryNoInputResult<TData, TError>)

RememberFireAndForgetMutationNoInputResult

data class RememberFireAndForgetMutationNoInputResult<TError : Throwable>(val fetchState: FetchState, val error: TError?, val mutate: suspend (optimisticUpdate: () -> Map<out CacheableInput, Any?>?, onSuccess: suspend () -> Unit?, onError: suspend (error: TError) -> Unit?) -> Unit) : CacheableResult<TError>

RememberFireAndForgetMutationResult

data class RememberFireAndForgetMutationResult<TInput : CacheableInput.MutationInput, TError : Throwable>(val fetchState: FetchState, val error: TError?, val mutate: suspend (queryInput: TInput, optimisticUpdate: (input: TInput) -> Map<out CacheableInput, Any?>?, onSuccess: suspend () -> Unit?, onError: suspend (error: TError) -> Unit?) -> Unit) : CacheableResult<TError>

RememberFlowNoInputResult

data class RememberFlowNoInputResult<TData, TError : Throwable>(val fetchState: FetchState, val error: TError?, val data: TData?, val launch: suspend (onEachSuccess: suspend (data: TData) -> Unit?, onError: suspend (error: TError) -> Unit?) -> Unit) : CacheableResultWithData<TData, TError>

RememberFlowResult

data class RememberFlowResult<TInput : CacheableInput.FlowInput, TData, TError : Throwable>(val fetchState: FetchState, val error: TError?, val data: TData?, val launch: suspend (queryInput: TInput, onEachSuccess: suspend (data: TData) -> Unit?, onError: suspend (error: TError) -> Unit?) -> Unit) : CacheableResultWithData<TData, TError>

RememberInfiniteQueryNoInputResult

data class RememberInfiniteQueryNoInputResult<TPageParam, TData, TError : Throwable>(val fetchState: FetchState, val error: TError?, val data: List<PagedData<TPageParam?, TData>>?, val hasNextPage: Boolean, val hasPreviousPage: Boolean, val fetchNextPage: suspend (onSuccess: suspend (pageData: PagedData<TPageParam?, TData>?) -> Unit?, onError: suspend (error: TError) -> Unit?) -> Unit, val fetchPreviousPage: suspend (onSuccess: suspend (pageData: PagedData<TPageParam?, TData>?) -> Unit?, onError: suspend (error: TError) -> Unit?) -> Unit, val fetchPage: suspend (page: TPageParam, onSuccess: suspend (pageData: PagedData<TPageParam?, TData>?) -> Unit?, onError: suspend (error: TError) -> Unit?) -> Unit) : CacheableResultWithData<List<PagedData<TPageParam?, TData>>, TError>

RememberInfiniteQueryResult

data class RememberInfiniteQueryResult<TInput : CacheableInput.QueryInput, TPageParam, TData, TError : Throwable>(val fetchState: FetchState, val error: TError?, val data: List<PagedData<TPageParam?, TData>>?, val hasNextPage: Boolean, val hasPreviousPage: Boolean, val fetchNextPage: suspend (queryInput: TInput, onSuccess: suspend (pageData: PagedData<TPageParam?, TData>?) -> Unit?, onError: suspend (error: TError) -> Unit?) -> Unit, val fetchPreviousPage: suspend (queryInput: TInput, onSuccess: suspend (pageData: PagedData<TPageParam?, TData>?) -> Unit?, onError: suspend (error: TError) -> Unit?) -> Unit, val fetchPage: suspend (queryInput: TInput, page: TPageParam, onSuccess: suspend (pageData: PagedData<TPageParam?, TData>?) -> Unit?, onError: suspend (error: TError) -> Unit?) -> Unit) : CacheableResultWithData<List<PagedData<TPageParam?, TData>>, TError>

RememberMutationNoInputResult

data class RememberMutationNoInputResult<TData, TError : Throwable>(val fetchState: FetchState, val error: TError?, val data: TData?, val mutate: suspend (optimisticUpdate: () -> Map<out CacheableInput, Any?>?, onSuccess: suspend (data: TData) -> Unit?, onError: suspend (error: TError) -> Unit?) -> Unit) : CacheableResultWithData<TData, TError>

RememberMutationResult

data class RememberMutationResult<TInput : CacheableInput.MutationInput, TData, TError : Throwable>(val fetchState: FetchState, val error: TError?, val data: TData?, val mutate: suspend (queryInput: TInput, optimisticUpdate: (input: TInput) -> Map<out CacheableInput, Any?>?, onSuccess: suspend (data: TData) -> Unit?, onError: suspend (error: TError) -> Unit?) -> Unit) : CacheableResultWithData<TData, TError>

RememberQueryNoInputResult

data class RememberQueryNoInputResult<TData, TError : Throwable>(val fetchState: FetchState, val error: TError?, val data: TData?, val query: suspend () -> Unit) : CacheableQuery<TData, TError>

RememberQueryResult

data class RememberQueryResult<TInput : CacheableInput.QueryInput, TData, TError : Throwable>(val fetchState: FetchState, val error: TError?, val data: TData?, val query: suspend (input: TInput) -> Unit) : CacheableQuery<TData, TError>

Functions

composeFlowFactoryOf

fun <TInput : CacheableInput.FlowInput, TData, TError : Throwable> composeFlowFactoryOf(factory: FlowFactoryWithInput<TInput, TData, TError>): ComposableFlow<TInput, TData, TError>

fun <TData, TError : Throwable> composeFlowFactoryOf(factory: FlowFactoryWithNoInput<TData, TError>): ComposableFlowNoInput<TData, TError>

composeInfiniteQueryFactoryOf

composeMutationFactoryOf

fun <TInput : CacheableInput.MutationInput, TError : Throwable> composeMutationFactoryOf(factory: FireAndForgetMutationFactoryWithInput<TInput, TError>): ComposableFireAndForgetMutation<TInput, TError>

fun <TError : Throwable> composeMutationFactoryOf(factory: FireAndForgetMutationFactoryWithNoInput<TError>): ComposableFireAndForgetMutationNoInput<TError>

fun <TInput : CacheableInput.MutationInput, TData, TError : Throwable> composeMutationFactoryOf(factory: MutationFactoryWithInput<TInput, TData, TError>): ComposableMutation<TInput, TData, TError>

fun <TData, TError : Throwable> composeMutationFactoryOf(factory: MutationFactoryWithNoInput<TData, TError>): ComposableMutationNoInput<TData, TError>

composeQueryFactoryOf

fun <TInput : CacheableInput.QueryInput, TData, TError : Throwable> composeQueryFactoryOf(factory: QueryFactoryWithInput<TInput, TData, TError>): ComposableQuery<TInput, TData, TError>

fun <TData, TError : Throwable> composeQueryFactoryOf(factory: QueryFactoryWithNoInput<TData, TError>): ComposableQueryNoInput<TData, TError>