@eleven-am/pondsocket 0.1.63 → 0.1.64

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eleven-am/pondsocket",
-  "version": "0.1.63",
+  "version": "0.1.64",
   "description": "PondSocket is a fast simple socket server",
   "keywords": [
     "socket",

package/types.d.ts

@@ -4,6 +4,7 @@ import { WebSocketServer } from 'ws';
 
 type Unsubscribe = () => void;
 
+export type default_t<T = any> = Record<string, T>;
 type IsParam<Path> = Path extends `:${infer Param}` ? Param : never;
 
 type FilteredParams<Path> = Path extends `${infer First}/${infer Second}`
@@ -21,12 +22,7 @@ type EventParams<Path> = {
     params: Params<Path>;
 }
 
-type Primitives = number | string | boolean | null | undefined;
-
-type PondObject = {
-    [key: string]: Primitives | PondObject | PondObject[];
-}
-
+type PondObject = default_t;
 type PondPresence = PondObject;
 type PondMessage = PondObject;
 type PondAssigns = PondObject;
@@ -56,6 +52,13 @@ type IncomingConnection<Path> = EventParams<Path> & {
     address: string;
 }
 
+interface LeaveEvent {
+    userId: string;
+    assigns: PondAssigns;
+}
+
+type LeaveCallback = (event: LeaveEvent) => void;
+
 interface UserData {
     assigns: PondAssigns;
     presence: PondPresence;
@@ -479,6 +482,12 @@ export declare class PondChannel {
      *});
      */
     broadcast (event: string, payload: PondMessage, channelName?: string): void;
+
+    /**
+     * @desc Handles the leave event for a user, can occur when a user disconnects or leaves a channel, use this to clean up any resources
+     * @param callback - The callback to execute when a user leaves
+     */
+    public onLeave (callback: LeaveCallback): void;
 }
 
 declare class PondSocket {