new Pagination(max [, offset])
Construct a pagination object.
Parameters:
| Name | Type | Argument | Description |
|---|---|---|---|
max |
number | the maximum number of results to return |
|
offset |
number |
<optional> |
the 0-based starting offset |
Members
-
max
-
Get the maximum number of results to return.
-
offset
-
Get the results starting offset.
The first available result starts at offset
0. Note this is a raw offset value, not a "page" offset.
Methods
-
toUriEncoding()
-
Get this object as a standard URI encoded (query parameters) string value.
Returns:
the URI encoded string
- Type
- string
-
withOffset(offset)
-
Copy constructor with a new
offsetvalue.Parameters:
Name Type Description offsetnumber the new offset to use
Returns:
a new instance
- Type
- Pagination