react-query-firebase / web/firestore / useCountQuery

Function: useCountQuery()

function useCountQuery<AppModelType>(options): UseQueryResult<number>;

Defined in: web/firestore/useCountQuery.ts:66

Executes a query with specified constraints and returns the count of matched documents.

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<number, Error, number, QueryKey>, "queryFn"> & Required<Pick<UseQueryOptions<number, Error, number, QueryKey>, "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<number>

An object containing the number of documents that match the query.

Example

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