react-query-firebase / web/firestore / buildCompositeFilter

Function: buildCompositeFilter()

function buildCompositeFilter<AppModelType>(query): 
  | null
  | QueryFilterConstraint;

Defined in: web/firestore/utils/buildCompositeFilter.ts:55

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

QueryElement<AppModelType>

Returns

| null | QueryFilterConstraint

Example

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