Alokai

DeprecatedPagination

Representation of a search results pagination DeprecatedPagination

export interface DeprecatedPagination {
	'currentPage'?: number;
	'pageSize'?: number;
	'sort'?: string;
	'totalPages'?: number;
	'totalResults'?: number;
}

Properties

NameRequiredTypeDescription
currentPageOptionalnumberThe current page number. The first page is number zero (0), the second page is number one (1), and so on {number} DeprecatedPagination
pageSizeOptionalnumberThe number of results per page. A page may have less results if there are less than a full page of results, only on the last page in the results {number} DeprecatedPagination
sortOptionalstringThe selected sort code {string} DeprecatedPagination
totalPagesOptionalnumberThe total number of pages. This is the number of pages, each of pageSize, required to display the totalResults. {number} DeprecatedPagination
totalResultsOptionalnumberThe total number of matched results across all pages {number} DeprecatedPagination

On this page