Skip to main content

DifferentialWatchedQuerySettings<RowType>

Settings for differential incremental watched queries using.

Extends

Type Parameters

Type Parameter
RowType

Properties

PropertyTypeDescriptionInherited from
placeholderData?RowType[]Initial result data which is presented while the initial loading is executing.DifferentialWatchedQueryOptions.placeholderData
queryWatchCompatibleQuery<RowType[]>The query here must return an array of items that can be differentiated.-
reportFetching?booleanIf true (default) the watched query will update its state to report on the fetching state of the query. Setting to false reduces the number of state changes if the fetch status is not relevant to the consumer.DifferentialWatchedQueryOptions.reportFetching
rowComparator?DifferentialWatchedQueryComparator<RowType>Row comparator used to identify and compare rows in the result set. If not provided, the default comparator will be used which keys items by their id property if available, otherwise it uses JSON stringification of the entire item for keying and comparison.DifferentialWatchedQueryOptions.rowComparator
throttleMs?numberThe minimum interval between queries.DifferentialWatchedQueryOptions.throttleMs
triggerOnTables?string[]By default, watched queries requery the database on any change to any dependent table of the query. Supplying an override here can be used to limit the tables which trigger querying the database.DifferentialWatchedQueryOptions.triggerOnTables