itd-api / RealtimeTransport

Interface: RealtimeTransport

Defined in: realtime/transport.ts:41

Канал получения событий в реальном времени.

Сейчас у платформы один такой канал — поток text/event-stream. Абстракция нужна на будущее: политика безопасности сайта уже разрешает wss://*.xn--d1ah4a.com, и когда появится WebSocket, достаточно будет добавить ещё одну реализацию этого интерфейса. Переподключение, обновление токена и разбор уведомлений от транспорта не зависят.

Properties

name

readonly name: string;

Defined in: realtime/transport.ts:43

Понятное имя для логов и диагностики.

Methods

connect()

connect(context): Promise<void>;

Defined in: realtime/transport.ts:51

Держит соединение, пока оно живо.

Должен завершиться, когда поток закрылся, и бросить исключение при ошибке. Отмена через context.signal должна приводить к AbortError.

Parameters

context

TransportContext

Returns

Promise<void>