itd-api / OperationRequestOptions

Interface: OperationRequestOptions

Defined in: core/options.ts:343

Подготовленный запрос с обязательным идентификатором операции.

Extends

• RawRequestOptions

Properties

baseUrl?

optional baseUrl?: string;

Defined in: core/options.ts:319

Хост этого запроса. Важнее, чем RawRequestOptions.service.

На посторонний основному API хост Bearer-токен по умолчанию не отправляется. Для осознанного разрешения укажите skipAuth: false.

Inherited from

RawRequestOptions.baseUrl

---

body?

optional body?: unknown;

Defined in: core/options.ts:322

Тело: будет отправлено как JSON. Для загрузки файлов передайте FormData.

Inherited from

RawRequestOptions.body

---

extensions?

optional extensions?: RequestExtensions;

Defined in: core/options.ts:289

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

Inherited from

RawRequestOptions.extensions

---

headers?

optional headers?: Record<string, string>;

Defined in: core/options.ts:267

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

Inherited from

RawRequestOptions.headers

---

method

method: string;

Defined in: core/options.ts:305

Inherited from

RawRequestOptions.method

---

operationId

operationId: OperationId;

Defined in: core/options.ts:344

Имя низкоуровневого запроса. Встроенные ресурсы задают его сами. Пользовательские значения должны начинаться с custom:.

Overrides

RawRequestOptions.operationId

---

path

path: string;

Defined in: core/options.ts:307

Путь с ведущим слэшем, например /api/posts. Завершающий слэш значим.

Inherited from

RawRequestOptions.path

---

query?

optional query?: QueryParams;

Defined in: core/options.ts:320

Inherited from

RawRequestOptions.query

---

rateLimitBucket?

optional rateLimitBucket?: string;

Defined in: core/options.ts:287

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

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

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

Inherited from

RawRequestOptions.rateLimitBucket

---

raw?

optional raw?: boolean;

Defined in: core/options.ts:339

Вернуть тело ответа без снятия обёртки { data: … }.

Inherited from

RawRequestOptions.raw

---

retry?

optional retry?: false | RetryOptions;

Defined in: core/options.ts:269

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

Inherited from

RawRequestOptions.retry

---

retrySafety?

optional retrySafety?: RetrySafety;

Defined in: core/options.ts:276

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

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

Inherited from

RawRequestOptions.retrySafety

---

service?

optional service?: string;

Defined in: core/options.ts:312

Имя сервиса, на хост которого уйдёт запрос. Без него запрос идёт на основной baseUrl клиента. Сервисы задаются опцией RuntimeOptions.services.

Inherited from

RawRequestOptions.service

---

signal?

optional signal?: AbortSignal;

Defined in: core/options.ts:263

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

Inherited from

RawRequestOptions.signal

---

skipAuth?

optional skipAuth?: boolean;

Defined in: core/options.ts:329

Не подставлять заголовок авторизации.

Явное false разрешает авторизацию и для разового внешнего baseUrl; без него токен автоматически отправляется только основному хосту и его поддоменам.

Inherited from

RawRequestOptions.skipAuth

---

skipAuthRefresh?

optional skipAuthRefresh?: boolean;

Defined in: core/options.ts:331

Не пытаться обновить токен при 401 — используется самими эндпоинтами авторизации.

Inherited from

RawRequestOptions.skipAuthRefresh

---

skipQueue?

optional skipQueue?: boolean;

Defined in: core/options.ts:337

Выполнить запрос мимо очереди.

Служебная настройка для интеграций. Встроенные вход и обновление токена проходят очередь.

Inherited from

RawRequestOptions.skipQueue

---

timeout?

optional timeout?: number;

Defined in: core/options.ts:265

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

Inherited from

RawRequestOptions.timeout