fix: Add type to system messages (#422)

To help users debug issues and avoid type errors we're adding system as a type of message users can add `on` callbacks
supabase · Sep 4, 2024 · c1b27e1 · c1b27e1
1 parent 95ab09e
commit c1b27e1
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/src/RealtimeChannel.ts b/src/RealtimeChannel.ts
@@ -97,10 +97,8 @@ export enum REALTIME_POSTGRES_CHANGES_LISTEN_EVENT {
 export enum REALTIME_LISTEN_TYPES {
   BROADCAST = 'broadcast',
   PRESENCE = 'presence',
-  /**
-   * listen to Postgres changes.
-   */
   POSTGRES_CHANGES = 'postgres_changes',
+  SYSTEM = 'system',
 }
 
 export enum REALTIME_SUBSCRIBE_STATES {
@@ -415,6 +413,11 @@ export default class RealtimeChannel {
       payload: T
     }) => void
   ): RealtimeChannel
+  on<T extends { [key: string]: any }>(
+    type: `${REALTIME_LISTEN_TYPES.SYSTEM}`,
+    filter: {},
+    callback: (payload: any) => void
+  ): RealtimeChannel
   on(
     type: `${REALTIME_LISTEN_TYPES}`,
     filter: { event: string; [key: string]: string },

diff --git a/tsconfig.json b/tsconfig.json
@@ -12,7 +12,6 @@
     "esModuleInterop": true,
     "moduleResolution": "Node",
     "forceConsistentCasingInFileNames": true,
-    "stripInternal": true,
-    "types": ["vitest/globals"]
+    "stripInternal": true
   }
 }