Filters #

Filters are classes decorated with the @AocFilter decorator and are used to define where conditions for searches.

Filters are typically used from the client's model-configs.

Example #

Filter to obtain customers whose birthday is today

@AocFilter(
  Customer,
  'filterByBirthday',
  _ => {
    const today = startOfToday();
    const offset = today.getTimezoneOffset();
    const todayWithOffset = addMinutes(today, offset);
    return { birthdate: { $startsWithNumber: `\\d\\d\\d\\d-${format(todayWithOffset, 'MM-dd')}.*` }}
  },
  false
)
export class CustomerFilter {}

Api #

Full definition in the API.