module@warp-drive/experiments/pagination @experimental

Interface InfinitePaginationState<RT = unknown, E = unknown>

interface InfinitePaginationState<RT = unknown, E = unknown> extends SharedPaginationState<RT, E> {
  readonly data: Iterable<ContentItem<RT>>;
  readonly hasNext: boolean;
  readonly hasPrevious: boolean;
  loadNext: () => Promise<RT | null>;
  loadPrev: () => Promise<RT | null>;
  readonly nextRequest: Future<RT> | null;
  readonly pages: Iterable<Readonly<PageCache<RT, E>>>;
  readonly previousRequest: Future<RT> | null;
  readonly totalPages: number;
  adoptPage(request: Future<RT>): Promise<RT | null>;
}

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

The infinite (accumulated view) surface of a PaginationState: render data, grow it with loadNext/loadPrev. This is what the <Paginate /> component yields in 'infinite' mode.

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

data

readonly data: Iterable<ContentItem<RT>>;

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

See PaginationState.data.

---

hasNext

readonly hasNext: boolean;

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

See PaginationState.hasNext.

---

hasPrevious

readonly hasPrevious: boolean;

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

See PaginationState.hasPrevious.

---

loadNext

loadNext: () => Promise<RT | null>;

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

See PaginationState.loadNext.

Returns

Promise<RT | null>

---

loadPrev

loadPrev: () => Promise<RT | null>;

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

See PaginationState.loadPrev.

Returns

Promise<RT | null>

---

nextRequest

readonly nextRequest: Future<RT> | null;

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

See PaginationState.nextRequest.

---

pages

readonly pages: Iterable<Readonly<PageCache<RT, E>>>;

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

See PaginationState.pages.

---

previousRequest

readonly previousRequest: Future<RT> | null;

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

See PaginationState.previousRequest.

---

totalPages

readonly totalPages: number;

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

See PaginationState.totalPages.

Inherited from

SharedPaginationState.totalPages