Class Paginator<T>

constructor

• new Paginator<T>(elements?, itemsPerPage?, wrapsAround?): Paginator<T>

• The paginator constructor.

  Type Parameters

  • T

  Parameters

  • Optional elements: MaybeArray<T>

  • itemsPerPage: number = 10

  • wrapsAround: boolean = false

  Returns Paginator<T>

items

Readonly wrapsAround

currentPage

• get currentPage(): number

• The internal current page.

  Returns number

hasNext

• get hasNext(): boolean

• Determine whether the paginator has a next page.

  Returns boolean

hasPrevious

• get hasPrevious(): boolean

• Determine whether the paginator has a previous page.

  Returns boolean

itemsPerPage

• get itemsPerPage(): number

• Number of items to return per page.

  Returns number

length

• get length(): number

• Get the length of all the items within the paginator.

  Returns number

pageCount

• get pageCount(): number

• Get the number of pages available.

  Returns number

[iterator]

• [iterator](): Iterator<T, any, undefined>

• Enable array like behaviour.

  Returns Iterator<T, any, undefined>

first

• first(): Paginator<T>

• Set thr paginator to the first page.

  Returns Paginator<T>

getAll

• getAll(): T[]

• Get all the items passed to the paginator.

  Returns T[]

getPages

• getPages(): T[][]

• Get the items in a matrix where one array is one page.

  Returns T[][]

has

• has(item): boolean

• Determine whether the paginator has the given item.

  Parameters

  • item: T

  Returns boolean

isOnPage

• isOnPage(item): boolean

• Determine whether the given item is on page based on deep equality.

  Parameters

  • item: T

  Returns boolean

jumpToItem

• jumpToItem(item): Paginator<T>

• Jump to the page where the item is based on deep equality.

  Parameters

  • item: T

  Returns Paginator<T>

last

• last(): Paginator<T>

• Set the paginator to the last page.

  Returns Paginator<T>

next

• next(): Paginator<T>

• Set the paginator to the next page.

  Returns Paginator<T>

page

• page(pageNum): Paginator<T>

• Set the page to the given page number.

  Parameters

  • pageNum: number

  Returns Paginator<T>

pop

• pop(): undefined | T

• Remove and return the last element of the paginator.

  Returns undefined | T

previous

• previous(): Paginator<T>

• Set paginator to the previous page.

  Returns Paginator<T>

push

• push(...items): 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

setItemsPerPage

• setItemsPerPage(count): Paginator<T>

• The setter method for the itemsPerPage property.

  Parameters

  • count: number

  Returns Paginator<T>

shift

• shift(): undefined | T

• Remove and return the first element of the paginator.

  Returns undefined | T

unshift

• unshift(...items): 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