itd-api / WebSocketTransport

Class: WebSocketTransport

Defined in: events/transports/websocket.ts:160

Транспорт исходных событий поверх стандартного WebSocket.

Implements

• EventTransport

Constructors

Constructor

new WebSocketTransport(options?): WebSocketTransport;

Defined in: events/transports/websocket.ts:172

Parameters

options?

WebSocketTransportOptions = {}

Returns

WebSocketTransport

Properties

name

readonly name: "ws" = 'ws';

Defined in: events/transports/websocket.ts:161

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

Implementation of

EventTransport.name

Methods

connect()

connect(context): Promise<void>;

Defined in: events/transports/websocket.ts:217

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

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

Parameters

context

EventTransportContext

Returns

Promise<void>

Implementation of

EventTransport.connect