Options
All
  • Public
  • Public/Protected
  • All
Menu

Module lib/realtime

Index

Type Aliases

Variables

Functions

Type Aliases

Realtime

Realtime: Pusher

Variables

Const Context

Context: Context<undefined | default> = ...

Functions

Provider

  • Provider(options: { children: ReactNode; client?: default }): ReactElement

  • Parameters

    • options: { children: ReactNode; client?: default }
      • children: ReactNode
      • Optional client?: default

    Returns ReactElement

useRealtime

useRealtimeEvent

  • useRealtimeEvent<T>(channelName: string, eventName: string, callback: ((data?: T) => void)): void

  • Type Parameters

    • T

    Parameters

    • channelName: string
    • eventName: string
    • callback: ((data?: T) => void)
        • (data?: T): void

        • Parameters

          • Optional data: T

          Returns void

    Returns void

Generated using TypeDoc