Class RealtimeChannel

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

new RealtimeChannel(topic: string, params: undefined | RealtimeChannelOptions, socket: RealtimeClient): RealtimeChannel
Parameters
- topic: string
  
  Topic name can be any string.
- params: undefined | RealtimeChannelOptions
- socket: RealtimeClient
Returns RealtimeChannel
- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:128

Properties

bindings

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

Type declaration

[key: string]: {
    callback: Function;
    filter: {
        [key: string]: any;
    };
    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
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:147
on<T>(type: "presence", filter: {
event: "join";
}, callback: ((payload: RealtimePresenceJoinPayload<T>) => void)): RealtimeChannel
Type Parameters
- T extends {
  [key: string]: any;
  }
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:150
on<T>(type: "presence", filter: {
event: "leave";
}, callback: ((payload: RealtimePresenceLeavePayload<T>) => void)): RealtimeChannel
Type Parameters
- T extends {
  [key: string]: any;
  }
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:155
on<T>(type: "postgres_changes", filter: RealtimePostgresChangesFilter<"*">, callback: ((payload: RealtimePostgresChangesPayload<T>) => void)): RealtimeChannel
Type Parameters
- T extends {
  [key: string]: any;
  }
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:160
on<T>(type: "postgres_changes", filter: RealtimePostgresChangesFilter<"INSERT">, callback: ((payload: RealtimePostgresInsertPayload<T>) => void)): RealtimeChannel
Type Parameters
- T extends {
  [key: string]: any;
  }
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:163
on<T>(type: "postgres_changes", filter: RealtimePostgresChangesFilter<"UPDATE">, callback: ((payload: RealtimePostgresUpdatePayload<T>) => void)): RealtimeChannel
Type Parameters
- T extends {
  [key: string]: any;
  }
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:166
on<T>(type: "postgres_changes", filter: RealtimePostgresChangesFilter<"DELETE">, callback: ((payload: RealtimePostgresDeletePayload<T>) => void)): RealtimeChannel
Type Parameters
- T extends {
  [key: string]: any;
  }
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:169
on(type: "broadcast", filter: {
    event: string;
}, callback: ((payload: {
    event: string;
    type: "broadcast";
    [key: string]: any;
}) => void)): RealtimeChannel
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";
      [key: string]: any;
  }) => void)
  
  Function to be invoked when event handler is triggered.
  - - (payload: {
          event: string;
          type: "broadcast";
          [key: string]: any;
      }): void
    - Parameters
      
      payload: {
          event: string;
          type: "broadcast";
          [key: string]: any;
      }
      
      [key: string]: any
      
      event: string
      
      type: "broadcast"
      
      Returns void
Returns RealtimeChannel
- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:178
on<T>(type: "broadcast", filter: {
    event: string;
}, callback: ((payload: {
    event: string;
    payload: T;
    type: "broadcast";
}) => void)): RealtimeChannel
Type Parameters
- T extends {
  [key: string]: any;
  }
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:185
on<T>(type: "system", filter: {}, callback: ((payload: any) => void)): RealtimeChannel
Type Parameters
- T extends {
  [key: string]: any;
  }
Parameters
- type: "system"
- filter: {}
- callback: ((payload: any) => void)
  - - (payload: any): void
    - Parameters
      
      payload: any
      
      Returns void
Returns RealtimeChannel
- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:194

presenceState

presenceState<T>(): RealtimePresenceState<T>
Type Parameters
- T extends {
  [key: string]: any;
  } = {}
Returns RealtimePresenceState<T>
- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:133

send

send(args: {
    event: string;
    payload?: any;
    type: "presence" | "postgres_changes" | "broadcast";
    [key: string]: any;
}, opts?: {
    [key: string]: any;
}): Promise<RealtimeChannelSendResponse>
Sends a message into the channel.
Parameters
- args: {
      event: string;
      payload?: any;
      type: "presence" | "postgres_changes" | "broadcast";
      [key: string]: any;
  }
  
  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: {
  [key: string]: any;
  }
  
  Options to be used during the send process
  - [key: string]: any
Returns Promise<RealtimeChannelSendResponse>
- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:206

subscribe(callback?: ((status: REALTIME_SUBSCRIBE_STATES, err?: Error) => void), timeout?: number): RealtimeChannel
Subscribe registers your client with the server
Parameters
- Optional callback: ((status: REALTIME_SUBSCRIBE_STATES, err?: Error) => void)
  - - (status: REALTIME_SUBSCRIBE_STATES, err?: Error): void
    - Parameters
      
      status: REALTIME_SUBSCRIBE_STATES
      
      Optional err: Error
      
      Returns void
- Optional timeout: number
Returns RealtimeChannel
- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:132

teardown

teardown(): void
Teardown the channel.

Destroys and stops related timers.

Returns void
- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:232

track

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

unsubscribe

unsubscribe(timeout?: number): Promise<"error" | "ok" | "timed out">
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">
- Defined in node_modules/@supabase/realtime-js/dist/module/RealtimeChannel.d.ts:226

untrack

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

updateJoinPayload

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

Class RealtimeChannel

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

topic: string

params: undefined | RealtimeChannelOptions

socket: RealtimeClient

Returns RealtimeChannel

Properties

bindings

Type declaration

[key: string]: { callback: Function; filter: { [key: string]: any; }; 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 { [key: string]: any; }

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 { [key: string]: any; }

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 { [key: string]: any; }

Parameters

type: "postgres_changes"

filter: RealtimePostgresChangesFilter<"*">

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

Parameters

payload: RealtimePostgresChangesPayload<T>

Returns void

Returns RealtimeChannel

Type Parameters

T extends { [key: string]: any; }

Parameters

type: "postgres_changes"

filter: RealtimePostgresChangesFilter<"INSERT">

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

Parameters

payload: RealtimePostgresInsertPayload<T>

Returns void

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

filter: {
event: "sync";
}

T extends {
[key: string]: any;
}

filter: {
event: "join";
}

T extends {
[key: string]: any;
}

filter: {
event: "leave";
}

T extends {
[key: string]: any;
}

T extends {
[key: string]: any;
}

T extends {
[key: string]: any;
}

T extends {
[key: string]: any;
}

filter: {
event: string;
}

callback: ((payload: {
event: string;
type: "broadcast";
[key: string]: any;
}) => void)

payload: {
event: string;
type: "broadcast";
[key: string]: any;
}

T extends {
[key: string]: any;
}

filter: {
event: string;
}

callback: ((payload: {
event: string;
payload: T;
type: "broadcast";
}) => void)

payload: {
event: string;
payload: T;
type: "broadcast";
}

T extends {
[key: string]: any;
}

T extends {
[key: string]: any;
} = {}

args: {
event: string;
payload?: any;
type: "presence" | "postgres_changes" | "broadcast";
[key: string]: any;
}

`Optional` payload?: any

`Optional` opts: {
[key: string]: any;
}