itd-api / OperationRequestOptions
Interface: OperationRequestOptions
Defined in: core/options.ts:359
Подготовленный запрос с обязательным идентификатором операции.
Extends
Properties
baseUrl?
optional baseUrl?: string;Defined in: core/options.ts:335
Хост этого запроса. Важнее, чем RawRequestOptions.service.
На посторонний основному API хост Bearer-токен по умолчанию не отправляется. Для осознанного разрешения укажите skipAuth: false.
Inherited from
body?
optional body?: unknown;Defined in: core/options.ts:338
Тело: будет отправлено как JSON. Для загрузки файлов передайте FormData.
Inherited from
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
method
method: string;Defined in: core/options.ts:321
Inherited from
operationId
operationId: OperationId;Defined in: core/options.ts:360
Имя низкоуровневого запроса. Встроенные ресурсы задают его сами. Пользовательские значения должны начинаться с custom:.
Overrides
path
path: string;Defined in: core/options.ts:323
Путь с ведущим слэшем, например /api/posts. Завершающий слэш значим.
Inherited from
query?
optional query?: QueryParams;Defined in: core/options.ts:336
Inherited from
rateLimitBucket?
optional rateLimitBucket?: string;Defined in: core/options.ts:303
Имя бакета, из которого списывается запрос.
Встроенные ресурсы берут его из каталога операций; низкоуровневый вызов без этой опции попадает в default.
Имя сверяется со встроенной картой — незнакомое отвергается ItdConfigError до отправки, независимо от того, включена ли очередь. Своё правило rateLimit.bucket заводит собственное пространство имён и проверку снимает.
Inherited from
RawRequestOptions.rateLimitBucket
raw?
optional raw?: boolean;Defined in: core/options.ts:355
Вернуть тело ответа без снятия обёртки { data: … }.
Inherited from
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
service?
optional service?: string;Defined in: core/options.ts:328
Имя сервиса, на хост которого уйдёт запрос. Без него запрос идёт на основной baseUrl клиента. Сервисы задаются опцией RuntimeOptions.services.
Inherited from
signal?
optional signal?: AbortSignal;Defined in: core/options.ts:274
Отмена запроса извне.
Inherited from
skipAuth?
optional skipAuth?: boolean;Defined in: core/options.ts:345
Не подставлять заголовок авторизации.
Явное false разрешает авторизацию и для разового внешнего baseUrl; без него токен автоматически отправляется только основному хосту и его поддоменам.
Inherited from
skipAuthRefresh?
optional skipAuthRefresh?: boolean;Defined in: core/options.ts:347
Не обновлять токен заранее и при 401 — используется эндпоинтами авторизации.
Inherited from
RawRequestOptions.skipAuthRefresh
skipQueue?
optional skipQueue?: boolean;Defined in: core/options.ts:353
Выполнить запрос мимо очереди.
Служебная настройка для интеграций. Встроенные вход и обновление токена проходят очередь.
Inherited from
timeout?
optional timeout?: number;Defined in: core/options.ts:276
Таймаут одной транспортной попытки только для этого запроса, мс.