Interface BaseSearchRequest<TSortFields, TFilter>

Generic search request interface that can be used for most search operations

interface BaseSearchRequest<TSortFields extends string, TFilter> {
    filter: TFilter;
    page?: SearchPageRequest;
    sort?: SearchSortRequest<TSortFields>;
}

Type Parameters

TSortFields extends string
TFilter

Hierarchy (View Summary)

BaseSearchRequest

Index

Properties

filter page? sort?

Properties

filter

filter: TFilter

Search filter criteria.

`Optional`page

page?: SearchPageRequest

Pagination criteria.

`Optional`sort

sort?: SearchSortRequest<TSortFields>

Sort field criteria.