itd-api / PluginContext

Interface: PluginContext

Defined in: core/plugins.ts:30

Что плагин получает при подключении.

Properties

baseUrl

baseUrl: string;

Defined in: core/plugins.ts:32

Базовый URL клиента — например чтобы разобрать абсолютные ссылки из ответа.

---

getAuthIdentity?

optional getAuthIdentity?: () => Promise<AuthIdentity>;

Defined in: core/plugins.ts:48

Загружает сессию и возвращает идентификаторы аккаунта и конкретной сессии из JWT.

Предпочтительнее getAuthScope для состояния, которое должно объединяться между несколькими экземплярами клиента одного аккаунта.

Returns

Promise<AuthIdentity>

---

getAuthScope?

optional getAuthScope?: () => string;

Defined in: core/plugins.ts:41

Непрозрачная fallback-область текущей авторизации.

Нужна плагинам, которые обязаны безопасно изолировать непрозрачный токен. Для объединения состояния копий одного аккаунта используйте getAuthIdentity.

Returns

string

---

logger

logger: Logger | undefined;

Defined in: core/plugins.ts:34

Отладочный вывод клиента, если он включён.

Methods

use()

use(transformer): void;

Defined in: core/plugins.ts:50

Добавляет обёртку запроса. Подключённые раньше оказываются снаружи.

Parameters

transformer

Transformer

Returns

void

---

useHooks()

useHooks(hooks): void;

Defined in: core/plugins.ts:57

Добавляет перехватчики отдельных сетевых попыток.

В отличие от use, они видят каждый retry и сырой Response до чтения тела. Несколько наборов хуков одного плагина вызываются в порядке регистрации.

Parameters

hooks

ClientHooks

Returns

void