Skip to main content

Query Filters

These utilities are used by the adapters to enhance querying for objects.

Learn more

To learn how to structure your query filters, read Filter and sort syntax.

FilterInput​

The FilterInput type defines the accepted formats for specifying filters in query functions of the adapters.

Possible types​

  • string[]: An array of filter strings.
  • string: A single filter string.
  • FilterGroup: Used for boolean searches. Contains filter strings and a logical operator to apply to the filter conditions.

FilterGroup​

The FilterGroup interface defines a flexible structure for constructing filters for boolean and taxonomy searches. It supports combining filters using logical operators and allows recursive nesting for complex filtering logic.

Properties​

  • type ('and' | 'or' | 'taxonomy'): Specifies how the contained filters are combined - either with logical AND, logical OR, or as a taxonomy filter.
  • filters ((string | FilterGroup)[]): An array of filter conditions, which can include raw string filters or nested FilterGroup objects for deeper logical groupings.