Class Pagination

A pagination criteria object.

Hierarchy

Pagination

Implements

UriEncodable

Index

Constructors

Properties

Accessors

Methods

toUriEncoding withOffset

Constructors

constructor

new Pagination(max?, offset?): Pagination
Construct a pagination object.
Parameters
- Optional max: number
  
  the maximum number of results to return
- Optional offset: number
  
  the 0-based starting offset
Returns Pagination
- Defined in src/main/domain/pagination.ts:16

Properties

`Private` `Readonly` #max

#max: number

`Private` `Readonly` #offset

#offset: number

Accessors

max

get max(): number
Get the maximum number of results to return.

Returns number
the maximum number of results
- Defined in src/main/domain/pagination.ts:26

offset

get offset(): number
Get the results starting offset.

The first available result starts at offset 0. Note this is a raw offset value, not a "page" offset.

Returns number
the starting result offset
- Defined in src/main/domain/pagination.ts:38

Methods

toUriEncoding

toUriEncoding(): string
Get this object as a standard URI encoded (query parameters) string value.

Returns string
the URI encoded string
Implementation of UriEncodable.toUriEncoding
- Defined in src/main/domain/pagination.ts:57

withOffset

withOffset(offset): Pagination
Copy constructor with a new offset value.
Parameters
- offset: number
  
  the new offset to use
Returns Pagination
a new instance
- Defined in src/main/domain/pagination.ts:48

Generated using TypeDoc