itd-api / WebSocketTransportOptions
Interface: WebSocketTransportOptions
Defined in: events/transports/websocket.ts:39
Настройки WebSocket-транспорта.
Properties
auth?
optional auth?: "auto" | "header" | "query";Defined in: events/transports/websocket.ts:45
Способ передачи токена. auto выбирает заголовок при инъекции и query иначе.
classifyOpenFailure?
optional classifyOpenFailure?: WebSocketOpenFailureClassifier;Defined in: events/transports/websocket.ts:56
Проверяет отказ до open, когда среда скрыла HTTP-статус WebSocket-upgrade. true преобразует отказ в UnauthorizedStreamError.
clock?
optional clock?: ItdClock;Defined in: events/transports/websocket.ts:58
Часы транспорта. Обычно подменяются только в тестах.
handshakeTimeout?
optional handshakeTimeout?: number;Defined in: events/transports/websocket.ts:51
Максимальное время установки соединения, мс. По умолчанию 20 000.
idleTimeout?
optional idleTimeout?: number;Defined in: events/transports/websocket.ts:47
Молчание открытого соединения до переподключения, мс. По умолчанию 90 000.
keepAlive?
optional keepAlive?: number;Defined in: events/transports/websocket.ts:49
Период текстового ping, мс. По умолчанию 30 000.
path?
optional path?: string;Defined in: events/transports/websocket.ts:41
Путь апгрейда. По умолчанию /api/ws.
webSocketImpl?
optional webSocketImpl?: WebSocketLike;Defined in: events/transports/websocket.ts:43
Реализация WebSocket для сред без глобальной либо для передачи заголовков апгрейда.