itd-api

Тема

itd-api / ItdClientOptions

Interface: ItdClientOptions ​

Defined in: types/options.ts:160

Опции конструктора ItdClient.

Все поля допускают явный undefined, чтобы можно было передавать значения, которых может не быть, — например new ItdClient({ auth: process.env.ITD_TOKEN }).

Properties ​

auth? ​

ts
optional auth?: AuthInput;

Defined in: types/options.ts:186

Авторизация. Без неё доступны только публичные эндпоинты.

autoRefresh? ​

ts
optional autoRefresh?: boolean;

Defined in: types/options.ts:195

Обновлять токен автоматически при ответе 401. По умолчанию true.

При false библиотека просто пробросит ItdAuthError, а обновлением вы управляете сами через itd.auth.refresh().

baseUrl? ​

ts
optional baseUrl?: string;

Defined in: types/options.ts:167

Базовый URL API. По умолчанию https://xn--d1ah4a.com.

Укажите здесь адрес своего прокси, если работаете из браузера: CORS для сторонних источников на итд.com, скорее всего, не настроен.

deviceId? ​

ts
optional deviceId?: string;

Defined in: types/options.ts:223

Значение заголовка X-Device-Id, который уходит с каждым запросом.

Сервер различает по нему записи в списке сессий, поэтому значение должно быть стабильным. Если не задать, библиотека заведёт идентификатор сама и сохранит его в ItdSession, так что при постоянном хранилище он переживёт перезапуск процесса.

fetch? ​

ts
optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Defined in: types/options.ts:203

Своя реализация fetch: для Deno, React Native, тестов или прокси.

Call Signature ​

ts
(input, init?): Promise<Response>;

MDN Reference

Parameters ​
input ​

URL | RequestInfo

init? ​

RequestInit

Returns ​

Promise<Response>

Call Signature ​

ts
(input, init?): Promise<Response>;

MDN Reference

Parameters ​
input ​

string | URL | Request

init? ​

RequestInit

Returns ​

Promise<Response>

headers? ​

ts
optional headers?: Record<string, string>;

Defined in: types/options.ts:215

Заголовки, добавляемые ко всем запросам, — например User-Agent для бота.

hooks? ​

ts
optional hooks?: ClientHooks;

Defined in: types/options.ts:211

Перехватчики запросов.

logger? ​

ts
optional logger?: boolean | Logger;

Defined in: types/options.ts:213

Отладочный вывод. true — писать в console.

mode? ​

ts
optional mode?: RuntimeMode;

Defined in: types/options.ts:233

Как обращаться с cookie. По умолчанию определяется по среде исполнения.

rateLimit? ​

ts
optional rateLimit?: false | RateLimitOptions;

Defined in: types/options.ts:209

Ограничение нагрузки. false отключает очередь.

reloginOnRefreshFailure? ​

ts
optional reloginOnRefreshFailure?: boolean;

Defined in: types/options.ts:201

Пытаться ли войти заново, если обновление токена не удалось.

Работает, только когда в auth переданы email и пароль. По умолчанию true.

retry? ​

ts
optional retry?: false | RetryOptions;

Defined in: types/options.ts:207

Повторные попытки. false отключает их полностью.

services? ​

ts
optional services?: Record<string, 
  | string
| Omit<ServiceDefinition, "name">>;

Defined in: types/options.ts:184

Сервисы платформы на отдельных доменах.

Ключ — имя сервиса, значение — базовый URL или определение целиком. Имя встроенного сервиса задаёт его хост. Встроен один: status — хост itd.platform.status().

Example ​

ts
const itd = new ItdClient({
  services: {
    status: 'https://my-proxy.example/status',
    pb: { baseUrl: 'https://pbapi.xn--d1ah4a.com', headers: { Referer: 'https://pixel.xn--d1ah4a.com/' } },
  },
});

storage? ​

ts
optional storage?: TokenStorage;

Defined in: types/options.ts:188

Где хранить сессию. По умолчанию MemoryTokenStorage.

timeout? ​

ts
optional timeout?: number;

Defined in: types/options.ts:205

Таймаут запроса в мс. По умолчанию 30000 — столько же использует сайт итд.com. 0 снимает ограничение.

userAgent? ​

ts
optional userAgent?: string | false;

Defined in: types/options.ts:231

Значение заголовка User-Agent. false — не отправлять его вовсе.

По умолчанию Mozilla/5.0 (compatible; itd-api/<версия>; …): fetch в Node не шлёт User-Agent сам, а сайт стоит за DDoS-Guard, который такие запросы может не пропустить. В браузере опция не действует — там заголовок менять запрещено.

Документация itd-api

MIT License