Interface UseChannelReturn

interface UseChannelReturn {
    broadcast: (event: string, payload?: any) => void;
    error: Error | null;
    isConnected: boolean;
    memberCount: number;
    presences: Record<string, PresenceEntry[]>;
}

Properties

broadcast: (event: string, payload?: any) => void

error: Error | null

Last server-side error for this channel (denied join, rate limit, …).

isConnected: boolean

memberCount: number

presences: Record<string, PresenceEntry[]>

Online members keyed by userId; each value is that user's presence entries (one per tab/connection).