Documentation / zerotal / orm / PaginateResult
Interface: PaginateResult<T>
Defined in: packages/orm/src/db/types.ts:101
Result of QueryBuilder.paginate — a full offset paginator with total row count, page metadata and URL helpers.
Type Parameters
T
T = Record<string, unknown>
Properties
data
data:
T[]
Defined in: packages/orm/src/db/types.ts:102
total
total:
number
Defined in: packages/orm/src/db/types.ts:103
page
page:
number
Defined in: packages/orm/src/db/types.ts:104
perPage
perPage:
number
Defined in: packages/orm/src/db/types.ts:105
lastPage
lastPage:
number
Defined in: packages/orm/src/db/types.ts:106
from
from:
number|null
Defined in: packages/orm/src/db/types.ts:108
Index (1-based) of the first item on this page, or null when the page is empty.
to
to:
number|null
Defined in: packages/orm/src/db/types.ts:110
Index (1-based) of the last item on this page, or null when the page is empty.
meta
meta:
PaginateMeta
Defined in: packages/orm/src/db/types.ts:112
Standard metadata block (from/to/path/total/…) for driving UI components.
hasMorePages
hasMorePages:
boolean
Defined in: packages/orm/src/db/types.ts:131
True when there is at least one more page after the current one.
onFirstPage
onFirstPage:
boolean
Defined in: packages/orm/src/db/types.ts:133
True when the current page is the first page.
onLastPage
onLastPage:
boolean
Defined in: packages/orm/src/db/types.ts:135
True when the current page is the last page.
Methods
nextPageUrl()
nextPageUrl(
baseUrl?,query?):string|null
Defined in: packages/orm/src/db/types.ts:118
URL for the next page, or null on the last page. Extra query params (e.g. filters) are merged and preserved.
Parameters
baseUrl?
string
query?
Record<string, string>
Returns
string | null
Example
result.nextPageUrl('/posts', { search: 'bun' })
previousPageUrl()
previousPageUrl(
baseUrl?,query?):string|null
Defined in: packages/orm/src/db/types.ts:123
URL for the previous page, or null on the first page. Extra query params are merged and preserved.
Parameters
baseUrl?
string
query?
Record<string, string>
Returns
string | null
url()
url(
page,baseUrl?,query?):string
Defined in: packages/orm/src/db/types.ts:129
Build the URL for any page number (relative to baseUrl, default the
paginator's configured path).
Parameters
page
number
baseUrl?
string
query?
Record<string, string>
Returns
string
Example
result.url(3) // '/posts?page=3'
elements()
elements(
each?): (number|"...")[]
Defined in: packages/orm/src/db/types.ts:141
Page-number window for a numbered pager, with "..." gaps —
e.g. [1, "...", 4, 5, 6, "...", 20].
Parameters
each?
number
Page links on each side of the current page (default 1).
Returns
(number | "...")[]
links()
links(
baseUrl?,query?):object[]
Defined in: packages/orm/src/db/types.ts:147
Array of page links — useful for rendering pagination UI. Extra query params are merged onto every link URL.
Parameters
baseUrl?
string
query?
Record<string, string>
Returns
object[]
Example
result.links('/posts', { search: 'bun' })