Skip to content

Commit 7ae917f

Browse files
author
devgioele
committed
document default values for page and size
1 parent ecdd719 commit 7ae917f

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

src/engine/pagination.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,14 @@ import {
1111
export type PaginationQuery = {
1212
/**
1313
* The page index.
14+
*
15+
* @default 0
1416
*/
1517
page: number
1618
/**
1719
* The size of one page.
20+
*
21+
* @default 15
1822
*/
1923
size: number
2024
}
@@ -28,7 +32,7 @@ export type ChangeQueryOptions = {
2832
/**
2933
* Whether the page should be reset to its default value when the query is changed.
3034
*
31-
* @default `true`
35+
* @default true
3236
*/
3337
resetPage: boolean
3438
}

0 commit comments

Comments
 (0)