@supabase/realtime-js - npm Package Compare versions

Comparing version 2.4.0 to 2.5.0

dist/main/lib/version.d.ts

@@ -1,2 +0,2 @@
-export declare const version = "2.4.0";
+export declare const version = "2.5.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.4.0';
+exports.version = '2.5.0';
 //# sourceMappingURL=version.js.map

dist/main/RealtimeChannel.d.ts

@@ -135,13 +135,3 @@ import { CHANNEL_STATES } from './lib/constants';
     /**
-     * Creates an event handler that listens to changes
-     * @param type Realtime feature (broadcast, presence, or postgres_changes)
-     * @param filter Pre-defined and custom values specific to the Realtime feature
-     * @param filter.schema Database schema
-     * @param filter.event Event to listen to. If listening to postgres_changes type
-     * then this value is one of INSERT, UPDATE, DELETE, *
-     * @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
+     * Creates an event handler that listens to changes.
      */
@@ -177,2 +167,17 @@ on(type: `${REALTIME_LISTEN_TYPES.BROADCAST}`, filter: {
     }>(type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`, filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE}`>, callback: (payload: RealtimePostgresUpdatePayload<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
+     */
     on<T extends {
@@ -179,0 +184,0 @@ [key: string]: any;

dist/module/lib/version.d.ts

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

dist/module/lib/version.js

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

dist/module/RealtimeChannel.d.ts

@@ -135,13 +135,3 @@ import { CHANNEL_STATES } from './lib/constants';
     /**
-     * Creates an event handler that listens to changes
-     * @param type Realtime feature (broadcast, presence, or postgres_changes)
-     * @param filter Pre-defined and custom values specific to the Realtime feature
-     * @param filter.schema Database schema
-     * @param filter.event Event to listen to. If listening to postgres_changes type
-     * then this value is one of INSERT, UPDATE, DELETE, *
-     * @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
+     * Creates an event handler that listens to changes.
      */
@@ -177,2 +167,17 @@ on(type: `${REALTIME_LISTEN_TYPES.BROADCAST}`, filter: {
     }>(type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`, filter: RealtimePostgresChangesFilter<`${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE}`>, callback: (payload: RealtimePostgresUpdatePayload<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
+     */
     on<T extends {
@@ -179,0 +184,0 @@ [key: string]: any;

package.json

 {
   "name": "@supabase/realtime-js",
-  "version": "2.4.0",
+  "version": "2.5.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.4.0'
+export const version = '2.5.0'

src/RealtimeChannel.ts

@@ -332,13 +332,3 @@ import { CHANNEL_EVENTS, CHANNEL_STATES } from './lib/constants'
   /**
-   * Creates an event handler that listens to changes
-   * @param type Realtime feature (broadcast, presence, or postgres_changes)
-   * @param filter Pre-defined and custom values specific to the Realtime feature
-   * @param filter.schema Database schema
-   * @param filter.event Event to listen to. If listening to postgres_changes type
-   * then this value is one of INSERT, UPDATE, DELETE, *
-   * @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
+   * Creates an event handler that listens to changes.
    */
@@ -384,2 +374,17 @@ on(
   ): 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 }>(
@@ -386,0 +391,0 @@ type: `${REALTIME_LISTEN_TYPES.POSTGRES_CHANGES}`,

No alert changes

Improved metrics

Total package byte prevSize

346908

increased by0.24%

Lines of code

6173

increased by0.24%

No dependency changes