itd-api / Page

Interface: Page<T>

Defined in: core/pagination.ts:11

Страница списка — единая форма для всех трёх схем пагинации API.

Какие необязательные поля заполнены, зависит от эндпоинта: у ленты это nextCursor, у подписчиков — page и total, у уведомлений — nextOffset. Обычно они не нужны: перебор берёт на себя Paginator.

Type Parameters

T

T

Properties

hasMore

hasMore: boolean;

Defined in: core/pagination.ts:15

Есть ли следующая страница.

---

items

items: T[];

Defined in: core/pagination.ts:13

Элементы страницы.

---

limit?

optional limit?: number;

Defined in: core/pagination.ts:26

Запрошенный размер страницы.

---

nextCursor?

optional nextCursor?: string | null;

Defined in: core/pagination.ts:22

Курсор следующей страницы.

Непрозрачен: у вкладки popular это номер страницы, у following — отметка времени. Передавайте его обратно как есть и не пытайтесь разобрать.

---

nextOffset?

optional nextOffset?: number;

Defined in: core/pagination.ts:30

Смещение для следующего запроса при схеме со смещением.

---

page?

optional page?: number;

Defined in: core/pagination.ts:24

Номер текущей страницы при постраничной схеме.

---

raw

raw: unknown;

Defined in: core/pagination.ts:32

Исходный ответ — на случай, если документация разошлась с реальностью.

---

total?

optional total?: number;

Defined in: core/pagination.ts:28

Общее число элементов, если сервер его сообщил.