react-query-firebase / firestore / useQuery

Function: useQuery()

function useQuery<AppModelType, DbModelType>(__namedParameters): UseQueryResult<AppModelType[]>

Defined in: src/firestore/useQuery.ts:44

Executes a query on a Firestore-like data source and returns the resulting documents as an array.

This hook utilizes an abstraction over React Query to asynchronously fetch data based on the provided query reference and constraints. It supports optional filtering, conversion, and additional query constraints.

Type Parameters

• AppModelType extends DocumentData = DocumentData

• DbModelType extends DocumentData = DocumentData

Parameters

__namedParameters

UseQueryOptions<AppModelType, DbModelType>

Returns

UseQueryResult<AppModelType[]>

Result containing an array of documents that match the query criteria.