Paginator

The paginate method returns a paginator object with these properties and methods:

{
  next(): `paginator`,
  previous(): `paginator`,
  refresh(): `paginator`,
  page: `int`,
  results: `entityObject[]`,
  size: `int`
}

Paginator object properties

Property	Type	Description
page	int	Represents the current page number in the pagination sequence.
size	int	The number of entity objects on the current page.
results	entityObject[]	Contains the entityObject instances on the current page.

Paginator object methods

Method	Return	Description
next	paginator	Returns a new paginator instance with the page property set to the next page.
previous	paginator	Returns a new paginator instance with the page property set to the previous page.
refresh	paginator	Re-runs the current request and returns an updated paginator object with refreshed data.