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