@supabase/realtime-js 2.1.0 → 2.3.0

package/src/RealtimeClient.ts

@@ -159,10 +159,17 @@ export default class RealtimeClient {
     }
   }
 
+  /**
+   * Returns all created channels
+   */
   getChannels(): RealtimeChannel[] {
     return this.channels
   }
 
+  /**
+   * Unsubscribes and removes a single channel
+   * @param channel A RealtimeChannel instance
+   */
   removeChannel(
     channel: RealtimeChannel
   ): Promise<RealtimeRemoveChannelResponse> {
@@ -174,6 +181,9 @@ export default class RealtimeClient {
     })
   }
 
+  /**
+   * Unsubscribes and removes all channels
+   */
   removeAllChannels(): Promise<RealtimeRemoveChannelResponse[]> {
     return Promise.all(
       this.channels.map((channel) => channel.unsubscribe())
@@ -186,7 +196,7 @@ export default class RealtimeClient {
   /**
    * Logs the message.
    *
-   * For customized logging, `this.logger` can be overriden.
+   * For customized logging, `this.logger` can be overridden.
    */
   log(kind: string, msg: string, data?: any) {
     this.logger(kind, msg, data)
@@ -209,7 +219,7 @@ export default class RealtimeClient {
   }
 
   /**
-   * Retuns `true` is the connection is open.
+   * Returns `true` is the connection is open.
    */
   isConnected(): boolean {
     return this.connectionState() === CONNECTION_STATE.Open

package/src/RealtimePresence.ts

@@ -10,25 +10,24 @@ import {
 } from 'phoenix'
 import RealtimeChannel from './RealtimeChannel'
 
-type Presence = {
+type Presence<T extends { [key: string]: any } = {}> = {
   presence_ref: string
-  [key: string]: any
-}
+} & T
 
 export type RealtimePresenceState = { [key: string]: Presence[] }
 
-export type RealtimePresenceJoinPayload = {
+export type RealtimePresenceJoinPayload<T extends { [key: string]: any }> = {
   event: `${REALTIME_PRESENCE_LISTEN_EVENTS.JOIN}`
   key: string
-  currentPresences: Presence[]
-  newPresences: Presence[]
+  currentPresences: Presence<T>[]
+  newPresences: Presence<T>[]
 }
 
-export type RealtimePresenceLeavePayload = {
+export type RealtimePresenceLeavePayload<T extends { [key: string]: any }> = {
   event: `${REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE}`
   key: string
-  currentPresences: Presence[]
-  leftPresences: Presence[]
+  currentPresences: Presence<T>[]
+  leftPresences: Presence<T>[]
 }
 
 export enum REALTIME_PRESENCE_LISTEN_EVENTS {

package/src/lib/version.ts

@@ -1 +1 @@
-export const version = '2.1.0'
+export const version = '2.3.0'