@itd-api/hydrate / HydratedRealtime
Type Alias: HydratedRealtime
type HydratedRealtime = object & ItdRealtime;Defined in: packages/hydrate/src/types.ts:365
Поток, передающий гидратированные уведомления и контексты.
Type Declaration
on()
on<K>(event, listener): Unsubscribe;Type Parameters
K
K extends keyof RealtimeEvents<RealtimeContext>
Parameters
event
K
listener
Listener<HydratedRealtimeEvent<K>>
Returns
Unsubscribe
once()
once<K>(event, listener): Unsubscribe;Type Parameters
K
K extends keyof RealtimeEvents<RealtimeContext>
Parameters
event
K
listener
Listener<HydratedRealtimeEvent<K>>
Returns
Unsubscribe
onNotification()
Call Signature
onNotification<T>(selector, handler): Unsubscribe;Type Parameters
T
T extends NotificationType
Parameters
selector
HydratedRealtimeNotificationSelector<T>
handler
HydratedRealtimeHandler<RealtimeContext<RealtimeNotificationUpdate<T>>>
Returns
Unsubscribe
Call Signature
onNotification<C>(guard, handler): Unsubscribe;Type Parameters
C
C extends RealtimeNotificationContext
Parameters
guard
(context) => context is HydratedRealtimeContext<C>
handler
Returns
Unsubscribe
Call Signature
onNotification(predicate, handler): Unsubscribe;Parameters
predicate
(context) => boolean
handler
HydratedRealtimeHandler<RealtimeNotificationContext>
Returns
Unsubscribe
onUpdate()
Call Signature
onUpdate(handler): Unsubscribe;Parameters
handler
Returns
Unsubscribe
Call Signature
onUpdate<T>(type, handler): Unsubscribe;Type Parameters
T
T extends "unreadCount" | "notification" | "unknown"
Parameters
type
T
handler
HydratedRealtimeHandler<RealtimeContext<RealtimeUpdateOfType<T>>>
Returns
Unsubscribe
Call Signature
onUpdate<C>(guard, handler): Unsubscribe;Type Parameters
C
C extends RealtimeContext
Parameters
guard
(context) => context is HydratedRealtimeContext<C>
handler
Returns
Unsubscribe
Call Signature
onUpdate(predicate, handler): Unsubscribe;Parameters
predicate
(context) => boolean
handler
Returns
Unsubscribe
use()
use(middleware): Unsubscribe;Parameters
middleware
| HydratedRealtimeMiddleware<RealtimeContext> | RealtimeMiddlewareObj<HydratedRealtimeContext<RealtimeContext>>
Returns
Unsubscribe