react-query-firebase / useQuery

Function: useQuery()

function useQuery<AppModelType>(options): UseQueryResult<AppModelType[]>;

Defined in: src/web/firestore/useQuery.ts:66

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

Type Parameters

AppModelType

AppModelType extends AppModel = AppModel

Parameters

options

Configuration options for the query.

collectionReference

CollectionReference<AppModelType, AppModelType>

Reference to a Firestore collection

compositeFilter?

QueryFilterConstraint

Composite filter

options

Omit<UseQueryOptions<AppModelType[], Error, AppModelType[], readonly unknown[]>, "queryFn"> & Required<Pick<UseQueryOptions<AppModelType[], Error, AppModelType[], readonly unknown[]>, "queryKey">>

Reqct-query options that must include queryKey and shall not define queryFn

queryConstraints?

QueryConstraint[] | QueryNonFilterConstraint[] = []

Non composite filter constraints such as limit, order, where

Returns

UseQueryResult<AppModelType[]>

An object containing documents that match the query.

Example

export const MyComponent = () => {
 const docs = useQuery({
     options: {
         queryKey: ['key']
     },
     collectionReference: collection(),
 });
 console.log(docs);
};