Interface ListSortOptions<SortByType>

Represents the options to sort a response.

interface ListSortOptions<SortByType> {
    isDescending?: boolean;
    itemsOnPage: number;
    page: number;
    sortBy: SortByType;
}

Type Parameters

SortByType

Hierarchy (View Summary)

ListSortOptions

Index

Properties

isDescending? itemsOnPage page sortBy

Properties

`Optional`isDescending

isDescending?: boolean

Sort by descending order.

itemsOnPage

itemsOnPage: number

Number of items per page. Must be between 1 and 100.

page

page: number

Number of the page to retrieve. Minimum is 1.

sortBy

sortBy: SortByType

How to sort the response.