itd-api / NotificationEventsOptions
Interface: NotificationEventsOptions<C>
Defined in: events/stream.ts:84
Настройки потока уведомлений.
Extends
Extended by
Type Parameters
C
C extends NotificationEventContext = NotificationEventContext
Properties
backoff?
optional backoff?: readonly number[];Defined in: events/reconnect.ts:22
Таблица пауз. Последнее значение действует для всех дальнейших попыток.
Inherited from
concurrency?
optional concurrency?: number;Defined in: events/stream.ts:127
Максимальное число одновременно обрабатываемых обновлений. По умолчанию 1.
handshakeTimeout?
optional handshakeTimeout?: number;Defined in: events/stream.ts:107
Сколько ждать ответа на запрос потока, прежде чем оборвать попытку, мс. По умолчанию 20 000. Защищает от зависания на установке соединения, когда idleTimeout ещё не действует. 0 отключает проверку. Только для потокового транспорта.
idleTimeout?
optional idleTimeout?: number;Defined in: events/stream.ts:101
Молчание сервера, после которого соединение считается мёртвым, мс. По умолчанию 90 000.
Сервер не присылает keep-alive, поэтому без этой проверки оборванное соединение может незаметно «зависнуть».
jitter?
optional jitter?: number;Defined in: events/reconnect.ts:24
Доля разброса, 0…1.
Inherited from
maxAttempts?
optional maxAttempts?: number;Defined in: events/reconnect.ts:26
Предел числа попыток.
Inherited from
pollInterval?
optional pollInterval?: number;Defined in: events/stream.ts:109
Как часто опрашивать сервер, если используется запасной транспорт.
reconnectOnOnline?
optional reconnectOnOnline?: boolean;Defined in: events/stream.ts:125
Переподключаться при восстановлении сети. По умолчанию true. Только в браузере.
reconnectOnVisible?
optional reconnectOnVisible?: boolean;Defined in: events/stream.ts:123
Переподключаться, когда вкладка снова становится видимой. По умолчанию true.
Только в браузере. У сайта итд.com такой обработки нет, из-за чего вкладка, пролежавшая в фоне, может остаться без соединения.
sequentialize?
optional sequentialize?: EventSequentializer<C>;Defined in: events/stream.ts:129
Возвращает ключи обновлений, которые нельзя обрабатывать одновременно.
syncCount?
optional syncCount?: boolean;Defined in: events/stream.ts:116
Запрашивать число непрочитанных при подключении. По умолчанию true.
Так поступает сайт итд.com: поток присылает только новые события, а начальное значение счётчика нужно получить отдельно.
transport?
optional transport?:
| EventTransport
| NotificationEventsTransport;Defined in: events/stream.ts:94
Транспорт. По умолчанию auto: поток событий, если среда умеет читать тело ответа по частям, иначе опрос.
Можно передать и свою реализацию EventTransport — это пригодится, если у платформы появится WebSocket либо нужен нестандартный способ доставки.