itd-api / PaginationOptions

Interface: PaginationOptions

Defined in: core/options.ts:293

Опции перебора страниц, не являющиеся параметрами метода API.

Extends

• RequestOptions

Properties

extensions?

optional extensions?: RequestExtensions;

Defined in: core/options.ts:289

Настройки подключённых плагинов.

Inherited from

RequestOptions.extensions

---

headers?

optional headers?: Record<string, string>;

Defined in: core/options.ts:267

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

Inherited from

RequestOptions.headers

---

maxPages?

optional maxPages?: number;

Defined in: core/options.ts:295

Максимальное число страниц; без значения перебор продолжается до конца списка.

---

rateLimitBucket?

optional rateLimitBucket?: string;

Defined in: core/options.ts:287

Имя бакета, из которого списывается запрос.

Встроенные ресурсы берут его из каталога операций; низкоуровневый вызов без этой опции попадает в default.

Имя сверяется со встроенной картой — незнакомое отвергается ItdConfigError до отправки, независимо от того, включена ли очередь. Своё правило rateLimit.bucket заводит собственное пространство имён и проверку снимает.

Inherited from

RequestOptions.rateLimitBucket

---

retry?

optional retry?: false | RetryOptions;

Defined in: core/options.ts:269

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

Inherited from

RequestOptions.retry

---

retrySafety?

optional retrySafety?: RetrySafety;

Defined in: core/options.ts:276

Явно переопределяет безопасность повтора операции.

Встроенные ресурсы получают значение из каталога. Опция предназначена для произвольных запросов.

Inherited from

RequestOptions.retrySafety

---

signal?

optional signal?: AbortSignal;

Defined in: core/options.ts:263

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

Inherited from

RequestOptions.signal

---

timeout?

optional timeout?: number;

Defined in: core/options.ts:265

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

Inherited from

RequestOptions.timeout