supabase.RealtimeChannel | /deps.ts | live@1.63.12

method supabase.RealtimeChannel.prototype.on

import { supabase } from "https://dotland.deno.dev/x/live@1.63.12/deps.ts";
const { RealtimeChannel } = supabase;

on(

type: `${REALTIME_LISTEN_TYPES.PRESENCE}`,

filter: { event: `${REALTIME_PRESENCE_LISTEN_EVENTS.SYNC}`; },

callback: () => void,

): RealtimeChannel

Creates an event handler that listens to changes.

on<T extends { [key: string]: any; }>(

type: `${REALTIME_LISTEN_TYPES.PRESENCE}`,

filter: { event: `${REALTIME_PRESENCE_LISTEN_EVENTS.JOIN}`; },

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

): RealtimeChannel

on<T extends { [key: string]: any; }>(

type: `${REALTIME_LISTEN_TYPES.PRESENCE}`,

filter: { event: `${REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE}`; },

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

): RealtimeChannel

on<T extends { [key: string]: any; }>(

type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`,

filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL}`>,

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

): RealtimeChannel

on<T extends { [key: string]: any; }>(

type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`,

filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT}`>,

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

): RealtimeChannel

on<T extends { [key: string]: any; }>(

type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`,

filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE}`>,

callback: (payload: RealtimePostgresUpdatePayload<T>) => void,

): RealtimeChannel

on<T extends { [key: string]: any; }>(

type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`,

filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE}`>,

callback: (payload: RealtimePostgresDeletePayload<T>) => void,

): RealtimeChannel

on(

type: `${REALTIME_LISTEN_TYPES.BROADCAST}`,

filter: { event: string; },

callback: (payload: { [key: string]: any; type: `${REALTIME_LISTEN_TYPES.BROADCAST}`; event: string; }) => void,

): RealtimeChannel

The following is placed here to display on supabase.com/docs/reference/javascript/subscribe.

on<T extends { [key: string]: any; }>(

type: `${REALTIME_LISTEN_TYPES.BROADCAST}`,

filter: { event: string; },

callback: (payload: { type: `${REALTIME_LISTEN_TYPES.BROADCAST}`; event: string; payload: T; }) => void,

): RealtimeChannel

Creates an event handler that listens to changes.

Parameters

type: `${REALTIME_LISTEN_TYPES.PRESENCE}`

filter: { event: `${REALTIME_PRESENCE_LISTEN_EVENTS.SYNC}`; }

callback: () => void

Returns

RealtimeChannel

Type Parameters

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

Parameters

type: `${REALTIME_LISTEN_TYPES.PRESENCE}`

filter: { event: `${REALTIME_PRESENCE_LISTEN_EVENTS.JOIN}`; }

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

Returns

RealtimeChannel

Type Parameters

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

Parameters

type: `${REALTIME_LISTEN_TYPES.PRESENCE}`

filter: { event: `${REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE}`; }

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

Returns

RealtimeChannel

Type Parameters

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

Parameters

type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`

filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL}`>

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

Returns

RealtimeChannel

Type Parameters

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

Parameters

type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`

filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT}`>

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

Returns

RealtimeChannel

Type Parameters

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

Parameters

type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`

filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE}`>

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

Returns

RealtimeChannel

Type Parameters

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

Parameters

type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`

filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE}`>

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

Returns

RealtimeChannel

The following is placed here to display on supabase.com/docs/reference/javascript/subscribe.

Parameters

type: `${REALTIME_LISTEN_TYPES.BROADCAST}`

One of "broadcast", "presence", or "postgres_changes".

filter: { event: string; }

Custom object specific to the Realtime feature detailing which payloads to receive.

callback: (payload: { [key: string]: any; type: `${REALTIME_LISTEN_TYPES.BROADCAST}`; event: string; }) => void

Function to be invoked when event handler is triggered.

Returns

RealtimeChannel

Type Parameters

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

Parameters

type: `${REALTIME_LISTEN_TYPES.BROADCAST}`

filter: { event: string; }

callback: (payload: { type: `${REALTIME_LISTEN_TYPES.BROADCAST}`; event: string; payload: T; }) => void

Returns

RealtimeChannel