@supabase/realtime-js - npm Package Compare versions

Comparing version 2.5.0 to 2.6.0

dist/main/lib/version.d.ts

@@ -1,2 +0,2 @@
-export declare const version = "2.5.0";
+export declare const version = "2.6.0";
 //# sourceMappingURL=version.d.ts.map

dist/main/lib/version.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
-exports.version = '2.5.0';
+exports.version = '2.6.0';
 //# sourceMappingURL=version.js.map

dist/main/RealtimeChannel.d.ts

@@ -137,9 +137,2 @@ import { CHANNEL_STATES } from './lib/constants';
      */
-    on(type: `${REALTIME_LISTEN_TYPES.BROADCAST}`, filter: {
-        event: string;
-    }, callback: (payload: {
-        type: `${REALTIME_LISTEN_TYPES.BROADCAST}`;
-        event: string;
-        [key: string]: any;
-    }) => void): RealtimeChannel;
     on(type: `${REALTIME_LISTEN_TYPES.PRESENCE}`, filter: {
@@ -167,20 +160,18 @@ event: `${REALTIME_PRESENCE_LISTEN_EVENTS.SYNC}`;
     }>(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;
     /**
      * The following is placed here to display on supabase.com/docs/reference/javascript/subscribe.
-     * @param type One of broadcast, presence, or postgres_changes.
-     * @param filter Custom object specific to the Realtime feature.
-     * @param filter.schema Database schema used only for postgres_changes type.
-     * @param filter.event Event to listen to.
-     * If listening to broadcast type, this can by any string.
-     * If listening to presence type, this is one of sync, join, or leave.
-     * If listening to postgres_changes type, this value is one of INSERT, UPDATE, DELETE, or *.
-     * @param filter.filter If listening to postgres_changes type then this value is used to specify
-     * the postgres changes filter (eq, neq, lt, lte, gt, or gte) and value to listen to.
-     * @param filter.table If listening to postgres_changes type then this value is used to specify
-     * the database table to listen to.
-     * @param callback Function to be invoked when event handler is triggered
+     * @param type One of "broadcast", "presence", or "postgres_changes".
+     * @param filter Custom object specific to the Realtime feature detailing which payloads to receive.
+     * @param callback Function to be invoked when event handler is triggered.
      */
-    on<T extends {
+    on(type: `${REALTIME_LISTEN_TYPES.BROADCAST}`, filter: {
+        event: string;
+    }, callback: (payload: {
+        type: `${REALTIME_LISTEN_TYPES.BROADCAST}`;
+        event: string;
         [key: string]: any;
-    }>(type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`, filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE}`>, callback: (payload: RealtimePostgresDeletePayload<T>) => void): RealtimeChannel;
+    }) => void): RealtimeChannel;
     send(payload: {
@@ -187,0 +178,0 @@ type: string;

dist/module/lib/version.d.ts

@@ -1,2 +0,2 @@
-export declare const version = "2.5.0";
+export declare const version = "2.6.0";
 //# sourceMappingURL=version.d.ts.map

dist/module/lib/version.js

@@ -1,2 +0,2 @@
-export const version = '2.5.0';
+export const version = '2.6.0';
 //# sourceMappingURL=version.js.map

dist/module/RealtimeChannel.d.ts

@@ -137,9 +137,2 @@ import { CHANNEL_STATES } from './lib/constants';
      */
-    on(type: `${REALTIME_LISTEN_TYPES.BROADCAST}`, filter: {
-        event: string;
-    }, callback: (payload: {
-        type: `${REALTIME_LISTEN_TYPES.BROADCAST}`;
-        event: string;
-        [key: string]: any;
-    }) => void): RealtimeChannel;
     on(type: `${REALTIME_LISTEN_TYPES.PRESENCE}`, filter: {
@@ -167,20 +160,18 @@ event: `${REALTIME_PRESENCE_LISTEN_EVENTS.SYNC}`;
     }>(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;
     /**
      * The following is placed here to display on supabase.com/docs/reference/javascript/subscribe.
-     * @param type One of broadcast, presence, or postgres_changes.
-     * @param filter Custom object specific to the Realtime feature.
-     * @param filter.schema Database schema used only for postgres_changes type.
-     * @param filter.event Event to listen to.
-     * If listening to broadcast type, this can by any string.
-     * If listening to presence type, this is one of sync, join, or leave.
-     * If listening to postgres_changes type, this value is one of INSERT, UPDATE, DELETE, or *.
-     * @param filter.filter If listening to postgres_changes type then this value is used to specify
-     * the postgres changes filter (eq, neq, lt, lte, gt, or gte) and value to listen to.
-     * @param filter.table If listening to postgres_changes type then this value is used to specify
-     * the database table to listen to.
-     * @param callback Function to be invoked when event handler is triggered
+     * @param type One of "broadcast", "presence", or "postgres_changes".
+     * @param filter Custom object specific to the Realtime feature detailing which payloads to receive.
+     * @param callback Function to be invoked when event handler is triggered.
      */
-    on<T extends {
+    on(type: `${REALTIME_LISTEN_TYPES.BROADCAST}`, filter: {
+        event: string;
+    }, callback: (payload: {
+        type: `${REALTIME_LISTEN_TYPES.BROADCAST}`;
+        event: string;
         [key: string]: any;
-    }>(type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`, filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE}`>, callback: (payload: RealtimePostgresDeletePayload<T>) => void): RealtimeChannel;
+    }) => void): RealtimeChannel;
     send(payload: {
@@ -187,0 +178,0 @@ type: string;

package.json

 {
   "name": "@supabase/realtime-js",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "Listen to realtime updates to your PostgreSQL database",
@@ -5,0 +5,0 @@ "keywords": [

src/lib/version.ts

@@ -1,1 +0,1 @@
-export const version = '2.5.0'
+export const version = '2.6.0'

src/RealtimeChannel.ts

@@ -335,11 +335,2 @@ import { CHANNEL_EVENTS, CHANNEL_STATES } from './lib/constants'
   on(
-    type: `${REALTIME_LISTEN_TYPES.BROADCAST}`,
-    filter: { event: string },
-    callback: (payload: {
-      type: `${REALTIME_LISTEN_TYPES.BROADCAST}`
-      event: string
-      [key: string]: any
-    }) => void
-  ): RealtimeChannel
-  on(
     type: `${REALTIME_LISTEN_TYPES.PRESENCE}`,
@@ -374,17 +365,2 @@ filter: { event: `${REALTIME_PRESENCE_LISTEN_EVENTS.SYNC}` },
   ): RealtimeChannel
-  /**
-   * The following is placed here to display on supabase.com/docs/reference/javascript/subscribe.
-   * @param type One of broadcast, presence, or postgres_changes.
-   * @param filter Custom object specific to the Realtime feature.
-   * @param filter.schema Database schema used only for postgres_changes type.
-   * @param filter.event Event to listen to.
-   * If listening to broadcast type, this can by any string.
-   * If listening to presence type, this is one of sync, join, or leave.
-   * If listening to postgres_changes type, this value is one of INSERT, UPDATE, DELETE, or *.
-   * @param filter.filter If listening to postgres_changes type then this value is used to specify
-   * the postgres changes filter (eq, neq, lt, lte, gt, or gte) and value to listen to.
-   * @param filter.table If listening to postgres_changes type then this value is used to specify
-   * the database table to listen to.
-   * @param callback Function to be invoked when event handler is triggered
-   */
   on<T extends { [key: string]: any }>(
@@ -395,3 +371,18 @@ type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`,
   ): RealtimeChannel
+  /**
+   * The following is placed here to display on supabase.com/docs/reference/javascript/subscribe.
+   * @param type One of "broadcast", "presence", or "postgres_changes".
+   * @param filter Custom object specific to the Realtime feature detailing which payloads to receive.
+   * @param callback Function to be invoked when event handler is triggered.
+   */
   on(
+    type: `${REALTIME_LISTEN_TYPES.BROADCAST}`,
+    filter: { event: string },
+    callback: (payload: {
+      type: `${REALTIME_LISTEN_TYPES.BROADCAST}`
+      event: string
+      [key: string]: any
+    }) => void
+  ): RealtimeChannel
+  on(
     type: `${REALTIME_LISTEN_TYPES}`,
@@ -398,0 +389,0 @@ filter: { event: string; [key: string]: string },

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

344955

decreased by-0.56%

Lines of code

6146

decreased by-0.44%

No dependency changes