react-query-firebase / web/firestore / useCompositeFilter

Function: useCompositeFilter()

function useCompositeFilter<AppModelType>(query): undefined | QueryCompositeFilterConstraint;

Defined in: web/firestore/useCompositeFilter.ts:41

A custom hook that constructs a composite or where query filter based on the provided query structure. It recursively builds query constraints using logical "or" or "and" operators.

Type Parameters

AppModelType

AppModelType extends AppModel = AppModel

Parameters

query

query?

CompositeFilter<AppModelType>

Returns

undefined | QueryCompositeFilterConstraint

Example

export const MyComponent = () => {
 const filter = useCompositeFilter({
     operator: "AND",
     children: [
         {
             field: "field",
             value: "value",
             op: "=="
         },
         ...(query ? [query] : [])
     ]
 });
 console.log(filter);
};