itd-api / NotificationEventsClient
Class: NotificationEventsClient<C>
Defined in: events/client.ts:48
Поток уведомлений с собственным конвейером запросов.
Тот же NotificationEvents, что доступен как itd.notifications.events, но собранный без полного клиента: ресурсы, билдеры и сессия сюда не входят. Нужен приложениям, которым от API нужны только события, — виджетам, счётчикам непрочитанного, фоновым слушателям.
Example
import { createNotificationEventsClient } from 'itd-api/events';
await using stream = createNotificationEventsClient({ auth: token });
stream.on('notification', ({ notification }) => console.log(notification.type));
await stream.connect();Extends
Type Parameters
C
C extends NotificationEventContext = NotificationEventContext
Constructors
Constructor
new NotificationEventsClient<C>(options?): NotificationEventsClient<C>;Defined in: events/client.ts:56
Parameters
options?
NotificationEventsClientOptions<C> = {}
Returns
NotificationEventsClient<C>
Overrides
NotificationEvents<C>.constructorAccessors
status
Get Signature
get status(): EventChannelStatus;Defined in: events/stream.ts:261
Текущее состояние соединения.
Returns
Inherited from
transport
Get Signature
get transport(): string;Defined in: events/stream.ts:266
Имя используемого транспорта.
Returns
string
Inherited from
Methods
[asyncDispose]()
asyncDispose: Promise<void>;Defined in: events/client.ts:105
Позволяет использовать поток с await using.
Returns
Promise<void>
connect()
connect(): Promise<void>;Defined in: events/stream.ts:397
Поднимает соединение.
Повторный вызов при уже живом соединении ничего не делает — это защита от двойного подключения при перерисовке интерфейса.
Возвращает управление сразу после запуска: соединение живёт в фоне.
Returns
Promise<void>
Throws
если создавший поток клиент уже освобождён
Inherited from
disconnect()
disconnect(): void;Defined in: events/stream.ts:412
Закрывает соединение и отменяет запланированные попытки.
Returns
void
Inherited from
dispose()
dispose(): Promise<void>;Defined in: events/client.ts:80
Окончательно освобождает поток и его конвейер: отключает соединение, дожидается обработчиков и останавливает очередь запросов.
Повторные вызовы возвращают тот же результат очистки.
Returns
Promise<void>
drain()
drain(): Promise<void>;Defined in: events/stream.ts:418
Ждёт завершения принятых обновлений и освобождения ресурсов остановленной сессии.
Returns
Promise<void>
Inherited from
on()
on<K>(event, listener): Unsubscribe;Defined in: events/stream.ts:286
Подписывается на событие потока.
Type Parameters
K
K extends keyof NotificationEventsMap<C>
Parameters
event
K
listener
Listener<NotificationEventsMap<C>[K]>
Returns
функция отписки
Inherited from
once()
once<K>(event, listener): Unsubscribe;Defined in: events/stream.ts:294
Подписывается на одно срабатывание.
Type Parameters
K
K extends keyof NotificationEventsMap<C>
Parameters
event
K
listener
Listener<NotificationEventsMap<C>[K]>
Returns
Inherited from
onNotification()
Call Signature
onNotification<T>(selector, handler): Unsubscribe;Defined in: events/stream.ts:354
Подписывает асинхронный обработчик на уведомления, подходящие под фильтр.
Type Parameters
T
T extends NotificationType
Parameters
selector
handler
EventHandler<C & NotificationContext<T>>
Returns
Inherited from
NotificationEvents.onNotification
Call Signature
onNotification<N>(guard, handler): Unsubscribe;Defined in: events/stream.ts:359
Подписывает асинхронный обработчик по функции сужения типа уведомления.
Type Parameters
N
N extends NotificationEventContext & NotificationContext
Parameters
guard
(context) => context is N
handler
EventHandler<N>
Returns
Inherited from
NotificationEvents.onNotification
Call Signature
onNotification(predicate, handler): Unsubscribe;Defined in: events/stream.ts:364
Подписывает асинхронный обработчик по пользовательскому условию.
Parameters
predicate
(context) => boolean
handler
EventHandler<C & NotificationContext>
Returns
Inherited from
NotificationEvents.onNotification
onUpdate()
Call Signature
onUpdate(handler): Unsubscribe;Defined in: events/stream.ts:314
Подписывает асинхронный обработчик на все нормализованные обновления.
Parameters
handler
EventHandler<C>
Returns
Inherited from
Call Signature
onUpdate<T>(type, handler): Unsubscribe;Defined in: events/stream.ts:316
Подписывает асинхронный обработчик на обновление указанного типа.
Type Parameters
T
T extends "unreadCount" | "notification" | "unknown"
Parameters
type
T
handler
EventHandler<C & NotificationEventContext<NotificationUpdateOfType<T>>>
Returns
Inherited from
Call Signature
onUpdate<N>(guard, handler): Unsubscribe;Defined in: events/stream.ts:321
Подписывает асинхронный обработчик по функции сужения типа.
Type Parameters
N
N extends NotificationEventContext
Parameters
guard
EventTypeGuard<N, C>
handler
EventHandler<N>
Returns
Inherited from
Call Signature
onUpdate(predicate, handler): Unsubscribe;Defined in: events/stream.ts:323
Подписывает асинхронный обработчик по пользовательскому условию.
Parameters
predicate
handler
EventHandler<C>
Returns
Inherited from
removeAllListeners()
removeAllListeners(): void;Defined in: events/stream.ts:423
Снимает подписки on() и once(). Остальные обработчики остаются.
Returns
void
Inherited from
NotificationEvents.removeAllListeners
use()
use(middleware): Unsubscribe;Defined in: events/stream.ts:309
Добавляет промежуточный обработчик или объект, предоставляющий его через middleware().
Обработчики выполняются в порядке регистрации. Если next() не вызван, обновление не передаётся дальше по цепочке, асинхронным обработчикам и слушателям событий.
Parameters
middleware
| EventMiddleware<C> | EventMiddlewareObject<C>
Returns
функция удаления обработчика