channel()

channel(topic: string, params?: RealtimeChannelOptions): RealtimeChannel

Create or reuse a channel. The SDK prefixes the topic with realtime:. The same topic returns the existing channel.

Parameters

topic

string

Channel name, any string

params

RealtimeChannelOptions

configOptionalobject

broadcast

Optional

{ ack?: boolean; self?: boolean; replay?: { since: number; limit?: number } }

Broadcast options

presence

Optional

{ key?: string; enabled?: boolean }

Presence options

private

Optional

boolean

Private channel (RLS)

postgres_changes_options

Optional

{ wait?: boolean; timeout?: number }

CDC subscription confirmation options

Response

RealtimeChannel

RealtimeChannel

Channel instance

Example

const channel = realtime.channel("room", {
  config: {
    private: false,
    broadcast: { self: true },
    presence: { key: "user-1" },
  },
});