Interface PageRequest<T>

Request for one page.

interface PageRequest<T = string> {
    offset?: number;
    order?: (a: T, b: T) => number;
    size: number;
}

Type Parameters

T = string

Index

Properties

offset? order? size

Properties

`Optional`offset

offset?: number

Zero-based offset; clamped to [0, total]. Default 0.

`Optional`order

order?: (a: T, b: T) => number

Comparator replacing the default id order. Ties fall back to the id order so the result stays stable.

size

size: number

Page size; must be a positive integer.