itd-api / ItdRealtime

Class: ItdRealtime

Defined in: realtime/stream.ts:188

Поток уведомлений в реальном времени.

Получается вызовом itd.realtime(). Соединение поднимается методом connect и держится само: обрывы, обновление токена и повторные попытки библиотека берёт на себя.

Example

const stream = itd.realtime();

stream.on('notification', ({ notification, unreadCount }) => {
  console.log(formatNotificationText(notification), unreadCount);
});
stream.on('status', (status) => console.log('соединение:', status));

await stream.connect();
// …позже
stream.disconnect();

Constructors

Constructor

new ItdRealtime(deps, options?): ItdRealtime;

Defined in: realtime/stream.ts:210

Parameters

deps

RealtimeDeps

options?

RealtimeOptions = {}

Returns

ItdRealtime

Accessors

status

Get Signature

get status(): RealtimeStatus;

Defined in: realtime/stream.ts:226

Текущее состояние соединения.

Returns

RealtimeStatus

---

transport

Get Signature

get transport(): string;

Defined in: realtime/stream.ts:231

Какой транспорт используется: sse или poll.

Returns

string

Methods

connect()

connect(): Promise<void>;

Defined in: realtime/stream.ts:271

Поднимает соединение.

Повторный вызов при уже живом соединении ничего не делает — это защита от двойного подключения при перерисовке интерфейса.

Возвращает управление сразу после запуска: соединение живёт в фоне.

Returns

Promise<void>

---

disconnect()

disconnect(): void;

Defined in: realtime/stream.ts:291

Закрывает соединение и отменяет запланированные попытки.

Returns

void

---

on()

on<K>(event, listener): Unsubscribe;

Defined in: realtime/stream.ts:251

Подписывается на событие потока.

Type Parameters

K

K extends keyof RealtimeEvents

Parameters

event

K

listener

Listener<RealtimeEvents[K]>

Returns

Unsubscribe

функция отписки

---

once()

once<K>(event, listener): Unsubscribe;

Defined in: realtime/stream.ts:256

Подписывается на одно срабатывание.

Type Parameters

K

K extends keyof RealtimeEvents

Parameters

event

K

listener

Listener<RealtimeEvents[K]>

Returns

Unsubscribe

---

removeAllListeners()

removeAllListeners(): void;

Defined in: realtime/stream.ts:311

Снимает все подписки. Соединение при этом не закрывается.

Returns

void