itd-api / RawRequestOptions

Interface: RawRequestOptions

Defined in: core/options.ts:301

Полное описание запроса для низкоуровневого itd.request().

Extends

• RequestOptions

Extended by

• OperationRequestOptions

Properties

baseUrl?

optional baseUrl?: string;

Defined in: core/options.ts:321

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

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

---

body?

optional body?: unknown;

Defined in: core/options.ts:324

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

---

extensions?

optional extensions?: RequestExtensions;

Defined in: core/options.ts:291

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

Inherited from

RequestOptions.extensions

---

headers?

optional headers?: Record<string, string>;

Defined in: core/options.ts:269

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

Inherited from

RequestOptions.headers

---

method

method: string;

Defined in: core/options.ts:307

---

operationId?

optional operationId?: OperationId;

Defined in: core/options.ts:306

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

---

path

path: string;

Defined in: core/options.ts:309

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

---

query?

optional query?: QueryParams;

Defined in: core/options.ts:322

---

rateLimitBucket?

optional rateLimitBucket?: string;

Defined in: core/options.ts:289

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

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

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

Inherited from

RequestOptions.rateLimitBucket

---

raw?

optional raw?: boolean;

Defined in: core/options.ts:341

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

---

retry?

optional retry?: false | RetryOptions;

Defined in: core/options.ts:271

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

Inherited from

RequestOptions.retry

---

retrySafety?

optional retrySafety?: RetrySafety;

Defined in: core/options.ts:278

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

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

Inherited from

RequestOptions.retrySafety

---

service?

optional service?: string;

Defined in: core/options.ts:314

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

---

signal?

optional signal?: AbortSignal;

Defined in: core/options.ts:265

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

Inherited from

RequestOptions.signal

---

skipAuth?

optional skipAuth?: boolean;

Defined in: core/options.ts:331

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

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

---

skipAuthRefresh?

optional skipAuthRefresh?: boolean;

Defined in: core/options.ts:333

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

---

skipQueue?

optional skipQueue?: boolean;

Defined in: core/options.ts:339

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

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

---

timeout?

optional timeout?: number;

Defined in: core/options.ts:267

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

Inherited from

RequestOptions.timeout