Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FacetRequestOptions

Package version

The options for facet evaluation

Hierarchy

  • FacetRequestOptions

Index

Properties

Properties

Optional filter

filter: undefined | string

Specifies the filter condition for the 'where' clause which will be run on main query's result, just before the actual faceting.

Optional sortBy

sortBy: undefined | string

The column name or query expression to sort on. Defaults to count if not present.

Optional sortOrder

sortOrder: FacetSortOrder

The sorting order by the selected column (count by default). Possible values include: 'asc', 'desc'. Default value: 'desc'.

Optional top

top: undefined | number

The maximum number of facet rows that should be returned.

Generated using TypeDoc