Class Paging

Class to represent the Paging of a paged response.

Author

Tiago Grosso tiagogrosso99@gmail.com

Since

0.1.0

Hierarchy

Paging

Index

Constructors

Properties

Methods

getAfter getBefore getCursors getNext getPaging getPrevious

Constructors

constructor

new Paging(pagingData: PagingData): Paging
The constructor.
Parameters
- pagingData: PagingData
  
  the paging data.
Returns Paging
- Defined in main/requests/data/Paging.ts:59

Properties

`Private` `Readonly` pagingData

pagingData: PagingData

The paging data.

Methods

getAfter

getAfter(): undefined | string
Gets the object after the one in the response.

Returns
the object after the one in the response.

Returns undefined | string
- Defined in main/requests/data/Paging.ts:113

getBefore

getBefore(): undefined | string
Gets the object before the one in the response.

Returns
the object before the one in the response.

Returns undefined | string
- Defined in main/requests/data/Paging.ts:104

getCursors

getCursors(): undefined | Cursors
Gets the cursors of the response.

Returns
the cursors of the response.

Returns undefined | Cursors
- Defined in main/requests/data/Paging.ts:77

getNext

getNext(): undefined | string
Gets the next page of the response.

Returns
the next page of the response.

Returns undefined | string
- Defined in main/requests/data/Paging.ts:95

getPaging

getPaging(): PagingData
Gets the paging of the response.

Returns
the paging of the response.

Returns PagingData
- Defined in main/requests/data/Paging.ts:68

getPrevious

getPrevious(): undefined | string
Gets the previous page of the response.

Returns
the previous page of the response.

Returns undefined | string
- Defined in main/requests/data/Paging.ts:86

Generated using TypeDoc