Interface QueryParams

Interface defining parameters for a search query.

interface QueryParams {
    pageNum?: number;
    pageSize?: number;
    sortFields?: SortField[];
    filterQueries?: string[];
    facets?: Facet[];
}

Index

Properties

pageNum? pageSize? sortFields? filterQueries? facets?

Properties

`Optional`pageNum

pageNum?: number

The page number to retrieve (0-based).

`Optional`pageSize

pageSize?: number

The number of items per page.

`Optional`sortFields

sortFields?: SortField[]

Fields to sort the results by.

`Optional`filterQueries

filterQueries?: string[]

Additional query strings to filter the results.

`Optional`facets

facets?: Facet[]

Facets to calculate for the search results.