Class: module:models/Pagination

module:models/Pagination()

new module:models/Pagination()

Constructs a new Pagination.

Source:

Members

(inner) currentPage :Number

The current page number. The first page is number zero (0), the second page is number one (1), and so on.

Type:
  • Number
Source:

(inner) pageSize :Number

The 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.

Type:
  • Number
Source:

(inner) sort :String

The selected sort code.

Type:
  • String
Source:

(inner) totalPages :Number

The total number of pages. This is the number of pages, each of pageSize, required to display the totalResults.

Type:
  • Number
Source:

(inner) totalResults :Number

The total number of matched results across all pages.

Type:
  • Number
Source:

Methods

(static) constructFromObject(data, obj) → {module:models/Pagination}

Constructs a Pagination from a plain JavaScript object, optionally creating a new instance. Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.

obj module:models/Pagination

Optional instance to populate.

Source:
Returns:

The populated Pagination instance.

Type
module:models/Pagination