RealtimeChannel | @supabase/supabase-js

A channel is the basic building block of Realtime and narrows the scope of data flow to subscribed clients. You can think of a channel as a chatroom where participants are able to see who's online and send and receive messages.

Hierarchy

RealtimeChannel

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RealtimeChannel(topic: string, params: RealtimeChannelOptions, socket: RealtimeClient): RealtimeChannel

- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:127
Parameters
- topic: string
- params: RealtimeChannelOptions
- socket: RealtimeClient
Returns RealtimeChannel

Properties

bindings

bindings: {}

Type declaration

[key: string]: { callback: Function; filter: {}; id?: string; type: string }[]

broadcastEndpointURL

broadcastEndpointURL: string

joinPush

joinPush: default

joinedOnce

joinedOnce: boolean

params

params: RealtimeChannelOptions

presence

presence: RealtimePresence

private

private: boolean

pushBuffer

pushBuffer: default[]

rejoinTimer

rejoinTimer: default

socket

socket: RealtimeClient

state

state: CHANNEL_STATES

subTopic

subTopic: string

timeout

timeout: number

topic

topic: string

Topic name can be any string.

Methods

on

on(type: "presence", filter: { event: "sync" }, callback: (() => void)): RealtimeChannel
on<T>(type: "presence", filter: { event: "join" }, callback: ((payload: RealtimePresenceJoinPayload<T>) => void)): RealtimeChannel
on<T>(type: "presence", filter: { event: "leave" }, callback: ((payload: RealtimePresenceLeavePayload<T>) => void)): RealtimeChannel
on<T>(type: "postgres_changes", filter: RealtimePostgresChangesFilter<"*">, callback: ((payload: RealtimePostgresChangesPayload<T>) => void)): RealtimeChannel
on<T>(type: "postgres_changes", filter: RealtimePostgresChangesFilter<"INSERT">, callback: ((payload: RealtimePostgresInsertPayload<T>) => void)): RealtimeChannel
on<T>(type: "postgres_changes", filter: RealtimePostgresChangesFilter<"UPDATE">, callback: ((payload: RealtimePostgresUpdatePayload<T>) => void)): RealtimeChannel
on<T>(type: "postgres_changes", filter: RealtimePostgresChangesFilter<"DELETE">, callback: ((payload: RealtimePostgresDeletePayload<T>) => void)): RealtimeChannel
on(type: "broadcast", filter: { event: string }, callback: ((payload: { event: string; type: "broadcast" }) => void)): RealtimeChannel
on<T>(type: "broadcast", filter: { event: string }, callback: ((payload: { event: string; payload: T; type: "broadcast" }) => void)): RealtimeChannel
on<T>(type: "system", filter: {}, callback: ((payload: any) => void)): RealtimeChannel

- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:146
Creates an event handler that listens to changes.

Parameters
- type: "presence"
- filter: { event: "sync" }
  - event: "sync"
- callback: (() => void)
  - - (): void
    - Returns void
Returns RealtimeChannel
- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:149
Type Parameters
- T extends {}
Parameters
- type: "presence"
- filter: { event: "join" }
  - event: "join"
- callback: ((payload: RealtimePresenceJoinPayload<T>) => void)
  - - (payload: RealtimePresenceJoinPayload<T>): void
    - Parameters
      - payload: RealtimePresenceJoinPayload<T>
      Returns void
Returns RealtimeChannel
- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:154
Type Parameters
- T extends {}
Parameters
- type: "presence"
- filter: { event: "leave" }
  - event: "leave"
- callback: ((payload: RealtimePresenceLeavePayload<T>) => void)
  - - (payload: RealtimePresenceLeavePayload<T>): void
    - Parameters
      - payload: RealtimePresenceLeavePayload<T>
      Returns void
Returns RealtimeChannel
- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:159
Type Parameters
- T extends {}
Parameters
- type: "postgres_changes"
- filter: RealtimePostgresChangesFilter<"*">
- callback: ((payload: RealtimePostgresChangesPayload<T>) => void)
  - - (payload: RealtimePostgresChangesPayload<T>): void
    - Parameters
      - payload: RealtimePostgresChangesPayload<T>
      Returns void
Returns RealtimeChannel
- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:162
Type Parameters
- T extends {}
Parameters
- type: "postgres_changes"
- filter: RealtimePostgresChangesFilter<"INSERT">
- callback: ((payload: RealtimePostgresInsertPayload<T>) => void)
  - - (payload: RealtimePostgresInsertPayload<T>): void
    - Parameters
      - payload: RealtimePostgresInsertPayload<T>
      Returns void
Returns RealtimeChannel
- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:165
Type Parameters
- T extends {}
Parameters
- type: "postgres_changes"
- filter: RealtimePostgresChangesFilter<"UPDATE">
- callback: ((payload: RealtimePostgresUpdatePayload<T>) => void)
  - - (payload: RealtimePostgresUpdatePayload<T>): void
    - Parameters
      - payload: RealtimePostgresUpdatePayload<T>
      Returns void
Returns RealtimeChannel
- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:168
Type Parameters
- T extends {}
Parameters
- type: "postgres_changes"
- filter: RealtimePostgresChangesFilter<"DELETE">
- callback: ((payload: RealtimePostgresDeletePayload<T>) => void)
  - - (payload: RealtimePostgresDeletePayload<T>): void
    - Parameters
      - payload: RealtimePostgresDeletePayload<T>
      Returns void
Returns RealtimeChannel
- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:177
The following is placed here to display on supabase.com/docs/reference/javascript/subscribe.

Parameters
- type: "broadcast"
  
  One of "broadcast", "presence", or "postgres_changes".
- filter: { event: string }
  
  Custom object specific to the Realtime feature detailing which payloads to receive.
  - event: string
- callback: ((payload: { event: string; type: "broadcast" }) => void)
  
  Function to be invoked when event handler is triggered.
  - - (payload: { event: string; type: "broadcast" }): void
    - Parameters
      - payload: { event: string; type: "broadcast" }
        [key: string]: any
        event: string
        type: "broadcast"
      Returns void
Returns RealtimeChannel
- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:184
Type Parameters
- T extends {}
Parameters
- type: "broadcast"
- filter: { event: string }
  - event: string
- callback: ((payload: { event: string; payload: T; type: "broadcast" }) => void)
  - - (payload: { event: string; payload: T; type: "broadcast" }): void
    - Parameters
      - payload: { event: string; payload: T; type: "broadcast" }
        event: string
        payload: T
        type: "broadcast"
      Returns void
Returns RealtimeChannel
- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:193
Type Parameters
- T extends {}
Parameters
- type: "system"
- filter: {}
- callback: ((payload: any) => void)
  - - (payload: any): void
    - Parameters
      - payload: any
      Returns void
Returns RealtimeChannel

presenceState

presenceState<T>(): RealtimePresenceState<T>

- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:132
Type Parameters
- T extends {} = {}
Returns RealtimePresenceState<T>

send

send(args: { event: string; payload?: any; type: "presence" | "postgres_changes" | "broadcast" }, opts?: {}): Promise<RealtimeChannelSendResponse>

- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:205
Sends a message into the channel.

Parameters
- args: { event: string; payload?: any; type: "presence" | "postgres_changes" | "broadcast" }
  
  Arguments to send to channel
  - [key: string]: any
  - event: string
    
    The name of the event being sent
  - Optional payload?: any
    
    Payload to be sent
  - type: "presence" | "postgres_changes" | "broadcast"
    
    The type of event to send
- Optional opts: {}
  
  Options to be used during the send process
  - [key: string]: any
Returns Promise<RealtimeChannelSendResponse>

subscribe(callback?: ((status: "SUBSCRIBED" | "TIMED_OUT" | "CLOSED" | "CHANNEL_ERROR", err?: Error) => void), timeout?: number): RealtimeChannel

- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:131
Subscribe registers your client with the server

Parameters
- Optional callback: ((status: "SUBSCRIBED" | "TIMED_OUT" | "CLOSED" | "CHANNEL_ERROR", err?: Error) => void)
  - - (status: "SUBSCRIBED" | "TIMED_OUT" | "CLOSED" | "CHANNEL_ERROR", err?: Error): void
    - Parameters
      - status: "SUBSCRIBED" | "TIMED_OUT" | "CLOSED" | "CHANNEL_ERROR"
      - Optional err: Error
      Returns void
- Optional timeout: number
Returns RealtimeChannel

track

track(payload: {}, opts?: {}): Promise<RealtimeChannelSendResponse>

- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:135
Parameters
- payload: {}
  - [key: string]: any
- Optional opts: {}
  - [key: string]: any
Returns Promise<RealtimeChannelSendResponse>

unsubscribe

unsubscribe(timeout?: number): Promise<"error" | "ok" | "timed out">

- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:225
Leaves the channel.

Unsubscribes from server events, and instructs channel to terminate on server. Triggers onClose() hooks.

To receive leave acknowledgements, use the a receive hook to bind to the server ack, ie: channel.unsubscribe().receive("ok", () => alert("left!") )

Parameters
- Optional timeout: number
Returns Promise<"error" | "ok" | "timed out">

untrack

untrack(opts?: {}): Promise<RealtimeChannelSendResponse>

- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:140
Parameters
- Optional opts: {}
  - [key: string]: any
Returns Promise<RealtimeChannelSendResponse>

updateJoinPayload

updateJoinPayload(payload: {}): void

- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:213
Parameters
- payload: {}
  - [key: string]: any
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

topic: string

params: RealtimeChannelOptions

socket: RealtimeClient

Returns RealtimeChannel

Properties

bindings

Type declaration

[key: string]: { callback: Function; filter: {}; id?: string; type: string }[]

broadcastEndpointURL

joinPush

joinedOnce

params

presence

private

pushBuffer

rejoinTimer

socket

state

subTopic

timeout

topic

Methods

on

Parameters

type: "presence"

filter: { event: "sync" }

event: "sync"

callback: (() => void)

Returns void

Returns RealtimeChannel

Type Parameters

T extends {}

Parameters

type: "presence"

filter: { event: "join" }

event: "join"

callback: ((payload: RealtimePresenceJoinPayload<T>) => void)

Parameters

payload: RealtimePresenceJoinPayload<T>

Returns void

Returns RealtimeChannel

Type Parameters

T extends {}

Parameters

type: "presence"

filter: { event: "leave" }

event: "leave"

callback: ((payload: RealtimePresenceLeavePayload<T>) => void)

Parameters

payload: RealtimePresenceLeavePayload<T>

Returns void

Returns RealtimeChannel

Type Parameters

T extends {}

Parameters

type: "postgres_changes"

filter: RealtimePostgresChangesFilter<"*">

callback: ((payload: RealtimePostgresChangesPayload<T>) => void)

Parameters

payload: RealtimePostgresChangesPayload<T>

Returns void

Returns RealtimeChannel

Type Parameters

T extends {}

Parameters

type: "postgres_changes"

filter: RealtimePostgresChangesFilter<"INSERT">

callback: ((payload: RealtimePostgresInsertPayload<T>) => void)

Parameters

payload: RealtimePostgresInsertPayload<T>

Returns void

Returns RealtimeChannel