Documentation

Documentation / @zerotal/orm / index / SimplePaginateResult

Interface: SimplePaginateResult<T>

Defined in: packages/orm/src/db/types.ts:216

Result of QueryBuilder.simplePaginate — "next/prev only" pagination that skips the expensive COUNT(*) query. There is no total or lastPage.

Type Parameters

T

T = Record<string, unknown>

Properties

data

data: T[]

Defined in: packages/orm/src/db/types.ts:217

perPage

perPage: number

Defined in: packages/orm/src/db/types.ts:218

page

page: number

Defined in: packages/orm/src/db/types.ts:219

from

from: number | null

Defined in: packages/orm/src/db/types.ts:221

Index (1-based) of the first item on this page, or null when empty.

to

to: number | null

Defined in: packages/orm/src/db/types.ts:223

Index (1-based) of the last item on this page, or null when empty.

hasMorePages

hasMorePages: boolean

Defined in: packages/orm/src/db/types.ts:225

True when another page follows (a perPage + 1 probe row was found).

onFirstPage

onFirstPage: boolean

Defined in: packages/orm/src/db/types.ts:227

True when the current page is the first page.

Methods

nextPageUrl()

nextPageUrl(baseUrl?, query?): string | null

Defined in: packages/orm/src/db/types.ts:228

Parameters

baseUrl?

string

query?

Record<string, string>

Returns

string | null

previousPageUrl()

previousPageUrl(baseUrl?, query?): string | null

Defined in: packages/orm/src/db/types.ts:229

Parameters

baseUrl?

string

query?

Record<string, string>

Returns

string | null

url()

url(page, baseUrl?, query?): string

Defined in: packages/orm/src/db/types.ts:230

Parameters

page

number

baseUrl?

string

query?

Record<string, string>

Returns

string