react-query-firebase / useInfiniteQuery

Function: useInfiniteQuery()

function useInfiniteQuery<AppModelType, TQueryKey>(options): UseInfiniteQueryResult<InfiniteData<AppModelType[], unknown>>;

Defined in: src/web/firestore/useInfiniteQuery.ts:88

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

Type Parameters

AppModelType

AppModelType extends AppModel = AppModel

TQueryKey

TQueryKey extends readonly unknown[] = readonly unknown[]

Parameters

options

Configuration options for the query.

collectionReference

CollectionReference<AppModelType, AppModelType>

Reference to a Firestore collection

compositeFilter?

QueryFilterConstraint

Composite filter

options

Omit<UseInfiniteQueryOptions<AppModelType[], Error, InfiniteData<AppModelType[], unknown>, TQueryKey, QueryNonFilterConstraint>, "queryFn"> & Required<Pick<UseInfiniteQueryOptions<AppModelType[], Error, InfiniteData<AppModelType[], unknown>, TQueryKey, QueryNonFilterConstraint>, "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

UseInfiniteQueryResult<InfiniteData<AppModelType[], unknown>>

An object containing documents that match the query.

Example

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