itd-api / RealtimeOptions

Interface: RealtimeOptions

Defined in: realtime/stream.ts:67

Настройки потока уведомлений.

Extends

• ReconnectOptions

Properties

backoff?

optional backoff?: readonly number[];

Defined in: realtime/reconnect.ts:22

Таблица пауз. Последнее значение действует для всех дальнейших попыток.

Inherited from

ReconnectOptions.backoff

---

handshakeTimeout?

optional handshakeTimeout?: number;

Defined in: realtime/stream.ts:88

Сколько ждать ответа на запрос потока, прежде чем оборвать попытку, мс. По умолчанию 20 000. Защищает от зависания на установке соединения, когда idleTimeout ещё не действует. 0 отключает проверку. Только для потокового транспорта.

---

idleTimeout?

optional idleTimeout?: number;

Defined in: realtime/stream.ts:82

Молчание сервера, после которого соединение считается мёртвым, мс. По умолчанию 90 000.

Сервер не присылает keep-alive, поэтому без этой проверки оборванное соединение может незаметно «зависнуть».

---

jitter?

optional jitter?: number;

Defined in: realtime/reconnect.ts:24

Доля разброса, 0…1.

Inherited from

ReconnectOptions.jitter

---

maxAttempts?

optional maxAttempts?: number;

Defined in: realtime/reconnect.ts:26

Предел числа попыток.

Inherited from

ReconnectOptions.maxAttempts

---

pollInterval?

optional pollInterval?: number;

Defined in: realtime/stream.ts:90

Как часто опрашивать сервер, если используется запасной транспорт.

---

reconnectOnOnline?

optional reconnectOnOnline?: boolean;

Defined in: realtime/stream.ts:106

Переподключаться при восстановлении сети. По умолчанию true. Только в браузере.

---

reconnectOnVisible?

optional reconnectOnVisible?: boolean;

Defined in: realtime/stream.ts:104

Переподключаться, когда вкладка снова становится видимой. По умолчанию true.

Только в браузере. У сайта итд.com такой обработки нет, из-за чего вкладка, пролежавшая в фоне, может остаться без соединения.

---

syncCount?

optional syncCount?: boolean;

Defined in: realtime/stream.ts:97

Запрашивать число непрочитанных при подключении. По умолчанию true.

Так поступает сайт итд.com: поток присылает только новые события, а начальное значение счётчика нужно получить отдельно.

---

transport?

optional transport?: 
  | RealtimeTransport
  | RealtimeTransportKind;

Defined in: realtime/stream.ts:75

Транспорт. По умолчанию auto: поток событий, если среда умеет читать тело ответа по частям, иначе опрос.

Можно передать и свою реализацию RealtimeTransport — это пригодится, если у платформы появится WebSocket либо нужен нестандартный способ доставки.