module@warp-drive/experiments/pagination @experimentalInterface PagedPaginationState<RT =
Interface PagedPaginationState<RT = unknown, E = unknown>
ts
interface PagedPaginationState<RT = unknown, E = unknown> extends SharedPaginationState<RT, E> {
readonly activePage:
| Readonly<PageCache<RT, E>>
| null;
readonly activePageRequest: Future<RT> | null;
loadPage: (url: string) => Promise<RT | null>;
readonly totalPages: number;
adoptPage(request: Future<RT>): Promise<RT | null>;
}The paged (single-page view) surface of a PaginationState: render activePageRequest, navigate with loadPage. This is what the <Paginate /> component yields in 'paged' mode (the default).
Extends
SharedPaginationState<RT,E>
Type Parameters
RT
RT = unknown
E
E = unknown
Methods
adoptPage()
ts
adoptPage(request: Future<RT>): Promise<RT | null>;See PaginationState.adoptPage.
Parameters
request
Future<RT>
Returns
Promise<RT | null>
Inherited from
SharedPaginationState.adoptPage
Properties
activePage
ts
readonly activePage:
| Readonly<PageCache<RT, E>>
| null;See PaginationState.activePage.
activePageRequest
ts
readonly activePageRequest: Future<RT> | null;See PaginationState.activePageRequest.
loadPage
ts
loadPage: (url: string) => Promise<RT | null>;Parameters
url
string
Returns
Promise<RT | null>
totalPages
ts
readonly totalPages: number;See PaginationState.totalPages.