soil-query-core/soil.query/Query

Query

interface Query<T> : Actor

Query as the base interface for an QueryClient implementations.

Parameters

T

Type of the return value from the query.

Properties

abstract val command: SendChannel<QueryCommand<T>>

Send Channel to manipulate the state of the query.

abstract val event: SharedFlow<QueryEvent>

Shared Flow to receive query events.

abstract val options: QueryOptions

The QueryOptions configured for the query.

abstract val state: StateFlow<QueryState<T>>

State Flow to receive the current state of the query.

Functions

abstract fun launchIn(scope: CoroutineScope): Job

Launches the actor.