itd-api / PaginationOptions
Interface: PaginationOptions
Defined in: core/options.ts:309
Опции перебора страниц, не являющиеся параметрами метода API.
Extends
Properties
deadline?
optional deadline?: number;Defined in: core/options.ts:278
Общий срок только для этого запроса, мс. См. RuntimeOptions.deadline.
Inherited from
extensions?
optional extensions?: RequestExtensions;Defined in: core/options.ts:305
Настройки подключённых плагинов.
Inherited from
headers?
optional headers?: Record<string, string>;Defined in: core/options.ts:280
Дополнительные заголовки.
Inherited from
maxPages?
optional maxPages?: number;Defined in: core/options.ts:311
Максимальное число страниц; без значения перебор продолжается до конца списка.
rateLimitBucket?
optional rateLimitBucket?: string;Defined in: core/options.ts:303
Имя бакета, из которого списывается запрос.
Встроенные ресурсы берут его из каталога операций; низкоуровневый вызов без этой опции попадает в default.
Имя сверяется со встроенной картой — незнакомое отвергается ItdConfigError до отправки, независимо от того, включена ли очередь. Своё правило rateLimit.bucket заводит собственное пространство имён и проверку снимает.
Inherited from
RequestOptions.rateLimitBucket
retry?
optional retry?: false | RetryOptions;Defined in: core/options.ts:285
Повторы только для этого запроса. Переопределяют глобальную настройку retry. Лестницу пауз после 429 не затрагивают — как и глобальное retry: false.
Inherited from
retrySafety?
optional retrySafety?: RetrySafety;Defined in: core/options.ts:292
Явно переопределяет безопасность повтора операции.
Встроенные ресурсы получают значение из каталога. Опция предназначена для произвольных запросов.
Inherited from
signal?
optional signal?: AbortSignal;Defined in: core/options.ts:274
Отмена запроса извне.
Inherited from
timeout?
optional timeout?: number;Defined in: core/options.ts:276
Таймаут одной транспортной попытки только для этого запроса, мс.