Class Paginator<T>

Utility to paginate data.

Type Parameters

T

Hierarchy

Paginator

Implements

Iterable<T>

Index

Constructors

Properties

elements internalCurrentPage internalItemsPerPage items wrapsAround

Accessors

currentPage hasNext hasPrevious itemsPerPage length pageCount

Methods

[iterator] _setPageItems first getAll getPages has isOnPage jumpToItem last next page pageNumberOf pop previous push setItemsPerPage shift unshift

Constructors

constructor

new Paginator<T>(elements?: MaybeArray<T>, itemsPerPage?: number, wrapsAround?: boolean): Paginator<T>
The paginator constructor.

Returns
Type Parameters
Type Parameters
- T
Parameters
- Optional elements: MaybeArray<T>
- itemsPerPage: number = 10
- wrapsAround: boolean = false
Returns Paginator<T>
- Defined in src/Support/Paginator.ts:114

Properties

`Protected` `Readonly` elements

elements: T[]

All the items passed to the paginator.

`Protected` internalCurrentPage

internalCurrentPage: number = 1

The internal current page. This is always at least 1.

`Protected` internalItemsPerPage

internalItemsPerPage: number = 10

The internal tacker for the items per page count.

items

items: T[] = []

Current page's items.

`Readonly` wrapsAround

wrapsAround: boolean

Boolean indicating whether the paginator should repeat or not.

Accessors

currentPage

get currentPage(): number
The internal current page.

Returns number
- Defined in src/Support/Paginator.ts:21

hasNext

get hasNext(): boolean
Determine whether the paginator has a next page.

Returns

Returns boolean
- Defined in src/Support/Paginator.ts:92

hasPrevious

get hasPrevious(): boolean
Determine whether the paginator has a previous page.

Returns

Returns boolean
- Defined in src/Support/Paginator.ts:83

itemsPerPage

get itemsPerPage(): number
Number of items to return per page.

Returns number
- Defined in src/Support/Paginator.ts:37

length

get length(): number
Get the length of all the items within the paginator.

Returns number
- Defined in src/Support/Paginator.ts:74

pageCount

get pageCount(): number
Get the number of pages available.

Returns

Returns number
- Defined in src/Support/Paginator.ts:67

Methods

[iterator]

[iterator](): Iterator<T, any, undefined>
Enable array like behaviour.

Returns Iterator<T, any, undefined>
Implementation of Iterable.__@iterator@87
- Defined in src/Support/Paginator.ts:99

`Private` _setPageItems

_setPageItems(): Paginator<T>
Private
The setter for the current page items.

Returns

Returns Paginator<T>
- Defined in src/Support/Paginator.ts:131

first

first(): Paginator<T>
Set thr paginator to the first page.

Returns

Returns Paginator<T>
- Defined in src/Support/Paginator.ts:158

getAll

getAll(): T[]
Get all the items passed to the paginator.

Returns

Returns T[]
- Defined in src/Support/Paginator.ts:348

getPages

getPages(): T[][]
Get the items in a matrix where one array is one page.

Returns

Returns T[][]
- Defined in src/Support/Paginator.ts:357

has

has(item: T): boolean
Determine whether the paginator has the given item.
Parameters
- item: T
Returns boolean
- Defined in src/Support/Paginator.ts:279

isOnPage

isOnPage(item: T): boolean
Determine whether the given item is on page based on deep equality.
Parameters
- item: T
Returns boolean
- Defined in src/Support/Paginator.ts:252

jumpToItem

jumpToItem(item: T): Paginator<T>
Jump to the page where the item is based on deep equality.
Parameters
- item: T
Returns Paginator<T>
- Defined in src/Support/Paginator.ts:261

last

last(): Paginator<T>
Set the paginator to the last page.

Returns

Returns Paginator<T>
- Defined in src/Support/Paginator.ts:170

next

next(): Paginator<T>
Set the paginator to the next page.

Returns

Returns Paginator<T>
- Defined in src/Support/Paginator.ts:218

page

page(pageNum: number): Paginator<T>
Set the page to the given page number.

Returns
Parameters
- pageNum: number
Returns Paginator<T>
- Defined in src/Support/Paginator.ts:184

`Private` pageNumberOf

pageNumberOf(item: T): number
Private
Get the page number where the item first occurs. If not found return -1
Parameters
- item: T
Returns number
- Defined in src/Support/Paginator.ts:241

pop

pop(): undefined | T
Remove and return the last element of the paginator.

Returns

Returns undefined | T
- Defined in src/Support/Paginator.ts:314

previous

previous(): Paginator<T>
Set paginator to the previous page.

Returns

Returns Paginator<T>
- Defined in src/Support/Paginator.ts:198

push

push(...items: T[]): number
Add one or more items to the end of the paginator. Returns the new length of the paginator.
Parameters
- Rest ...items: T[]
Returns number
- Defined in src/Support/Paginator.ts:289

setItemsPerPage

setItemsPerPage(count: number): Paginator<T>
The setter method for the itemsPerPage property.

Returns
Parameters
- count: number
Returns Paginator<T>
- Defined in src/Support/Paginator.ts:146

shift

shift(): undefined | T
Remove and return the first element of the paginator.

Returns

Returns undefined | T
- Defined in src/Support/Paginator.ts:331

unshift

unshift(...items: T[]): number
Add one or more items to the beginning of the paginator. Returns the new length of the paginator.
Parameters
- Rest ...items: T[]
Returns number
- Defined in src/Support/Paginator.ts:302

Generated using TypeDoc