Class BaseList<T>`Abstract`

Type Parameters

T

Hierarchy (view full)

BaseList
- PaymentCycleEntryList
- PaymentCycleList

Index

Constructors

Properties

count data page totalCount

Constructors

constructor

new BaseList<T>(source, data): BaseList<T>
Converts a paged data response from the API into an SDK friendly format.
Type Parameters
- T
Parameters
- source: IApiList<T>
  The API response that contains paging information about the list
- data: undefined | T[]
  The actual list items returned from the API.
Returns BaseList<T>
- Defined in src/resources/BaseList.ts:38

Properties

count

count: number

This is the count of records returned

data

data: T[]

page

page: number

The page this list represents

totalCount

totalCount: number

This is the total count of records available, Needed for pagination