Skip to content
Functioncorev0.10.0

paginate

Pure page math, usable headless. Clamps page into range and slices the window.

Throws:

  • SeedcordRangeError when perPage is not a positive integer.

paginate<Item>(
    items: readonly Item[],
    page: number,
    perPage: number
): PageView<Item>

Item

Item

items

items: readonly Item[]

The full list to page over.

page

page: number

The requested zero-based page, clamped into [0, totalPages - 1].

perPage

perPage: number

The page size. Must be a positive integer.