Constructor
new Pagination(max, offsetopt)
Construct a pagination object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
max | number | the maximum number of results to return | |
offset | number | <optional> | the 0-based starting offset |
- Source
Members
max
Get the maximum number of results to return.
- Source
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.
- Source
Methods
toUriEncoding() → {string}
Get this object as a standard URI encoded (query parameters) string value.
- Source
Returns:
the URI encoded string
- Type:
- string
withOffset(offset) → {Pagination}
Copy constructor with a new offset value.
Parameters:
| Name | Type | Description |
|---|---|---|
offset | number | the new offset to use |
- Source
Returns:
a new instance
- Type:
- Pagination