react-query-firebase / web/firestore / useQueryConstraints

Function: useQueryConstraints()

function useQueryConstraints<AppModelType>(constraints): QueryNonFilterConstraint[];

Defined in: web/firestore/useQueryConstraints.ts:38

A hook to build a list of non-filter query constraints for firebase queries. It uses buildQueryConstraint method and useMemo hook.

Type Parameters

AppModelType

AppModelType extends AppModel = AppModel

Parameters

constraints

constraints

NonFilterQueryConstraint<AppModelType>[]

A list of constraints such as limit, order, offset.

Returns

QueryNonFilterConstraint[]

Example

const firebaseConfig = {};
export const constraint = useQueryConstraints([
 {
     type: 'limit',
     limit: 1
 }
]};