itd-api / UserListParams

Interface: UserListParams

Defined in: resources/users.ts:27

Параметры списков пользователей.

⚠️ Списки подписчиков, подписок и заблокированных на сервере не листаются: page он игнорирует, а limit зажимает на 20. Подробности — в UsersResource.followers.

Extends

• RequestOptions

Properties

headers?

optional headers?: Record<string, string>;

Defined in: types/options.ts:243

Дополнительные заголовки.

Inherited from

RequestOptions.headers

---

limit?

optional limit?: number;

Defined in: resources/users.ts:29

Сколько записей вернуть. Значения больше 20 сервер молча уменьшает до 20.

---

maxPages?

optional maxPages?: number;

Defined in: resources/users.ts:32

---

page?

optional page?: number;

Defined in: resources/users.ts:31

Номер страницы. Сервер его игнорирует — оставлен на случай, если пагинацию починят.

---

retry?

optional retry?: false | RetryOptions;

Defined in: types/options.ts:245

Повторы только для этого запроса. Переопределяют глобальную настройку retry.

Inherited from

RequestOptions.retry

---

signal?

optional signal?: AbortSignal;

Defined in: types/options.ts:239

Отмена запроса извне.

Inherited from

RequestOptions.signal

---

timeout?

optional timeout?: number;

Defined in: types/options.ts:241

Таймаут только для этого запроса, мс.

Inherited from

RequestOptions.timeout