Merge pull request #116 from ftonato/feature/add-type-event-types

feat: add EventTypes as a Type

Author: kiwicopple

src/lib/SupabaseQueryBuilder.ts

@@ -1,7 +1,7 @@
 import { PostgrestQueryBuilder } from '@supabase/postgrest-js'
 import { SupabaseRealtimeClient } from './SupabaseRealtimeClient'
 import { RealtimeClient } from '@supabase/realtime-js'
-import { SupabaseRealtimePayload } from './types'
+import { SupabaseEventTypes, SupabaseRealtimePayload } from './types'
 
 export class SupabaseQueryBuilder<T> extends PostgrestQueryBuilder<T> {
   private _subscription: SupabaseRealtimeClient
@@ -33,7 +33,7 @@ export class SupabaseQueryBuilder<T> extends PostgrestQueryBuilder<T> {
    * @param callback A callback that will handle the payload that is sent whenever your database changes.
    */
   on(
-    event: 'INSERT' | 'UPDATE' | 'DELETE' | '*',
+    event: SupabaseEventTypes,
     callback: (payload: SupabaseRealtimePayload<T>) => void
   ): SupabaseRealtimeClient {
     if (!this._realtime.isConnected()) {

src/lib/SupabaseRealtimeClient.ts

@@ -1,5 +1,5 @@
 import { RealtimeSubscription, RealtimeClient, Transformers } from '@supabase/realtime-js'
-import { SupabaseRealtimePayload } from './types'
+import { SupabaseEventTypes, SupabaseRealtimePayload } from './types'
 
 export class SupabaseRealtimeClient {
   subscription: RealtimeSubscription
@@ -39,7 +39,7 @@ export class SupabaseRealtimeClient {
    * @param event The event
    * @param callback A callback function that is called whenever the event occurs.
    */
-  on(event: 'INSERT' | 'UPDATE' | 'DELETE' | '*', callback: Function) {
+  on(event: SupabaseEventTypes, callback: Function) {
     this.subscription.on(event, (payload: any) => {
       let enrichedPayload: SupabaseRealtimePayload<any> = {
         schema: payload.schema,

src/lib/types.ts

@@ -35,3 +35,5 @@ export type SupabaseRealtimePayload<T> = {
   /** The previous record. Present for 'UPDATE' and 'DELETE' events. */
   old: T
 }
+
+export type SupabaseEventTypes = 'INSERT' | 'UPDATE' | 'DELETE' | '*'