react-query-firebase / useFirestoreQueryEngine

Function: useFirestoreQueryEngine()

function useFirestoreQueryEngine<AppModelType>(): (options) => Promise<AppModelType[]>;

Defined in: src/web/firestore/useFirestoreQueryEngine.ts:51

Returns an async wrapper around native firestore query engine.

Type Parameters

AppModelType

AppModelType extends AppModel = AppModel

Returns

A function to execute firestore query

(options): Promise<AppModelType[]>;

Parameters

options

collectionReference

CollectionReference<AppModelType, AppModelType>

Reference to a Firestore collection

compositeFilter?

CompositeFilter

Composite filter

queryConstraints

NonFilterQueryConstraint<AppModelType>[]

Non composite filter constraints such as limit, order, where

Returns

Promise<AppModelType[]>

Example

export const MyComponent = () => {
 const query = useFirestoreQueryEngine();
 const callback = useCallback(async () => {
     const docs = await query({
         collectionReference: collection(),
         queryConstraints: [],
     });
     // do something with docs
 });
};