module@warp-drive/experiments/pagination @experimental

Interface PagedPaginationState<RT = unknown, E = unknown>

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>;
}

Defined in: warp-drive-packages/core/src/signals/pagination-state.ts:52

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()

adoptPage(request: Future<RT>): Promise<RT | null>;

Defined in: warp-drive-packages/core/src/signals/pagination-state.ts:34

See PaginationState.adoptPage.

Parameters

request

Future<RT>

Returns

Promise<RT | null>

Inherited from

SharedPaginationState.adoptPage

Properties

activePage

readonly activePage: 
  | Readonly<PageCache<RT, E>>
  | null;

Defined in: warp-drive-packages/core/src/signals/pagination-state.ts:54

See PaginationState.activePage.

---

activePageRequest

readonly activePageRequest: Future<RT> | null;

Defined in: warp-drive-packages/core/src/signals/pagination-state.ts:56

See PaginationState.activePageRequest.

---

loadPage

loadPage: (url: string) => Promise<RT | null>;

Defined in: warp-drive-packages/core/src/signals/pagination-state.ts:58

See PaginationState.loadPage.

Parameters

url

string

Returns

Promise<RT | null>

---

totalPages

readonly totalPages: number;

Defined in: warp-drive-packages/core/src/signals/pagination-state.ts:32

See PaginationState.totalPages.

Inherited from

SharedPaginationState.totalPages