🏷 add metadata type to useEvent (test missing, pending pusher-js-mock…

… update)

src/__tests__/useEvent.tsx

@@ -1,5 +1,5 @@
-import { Channel } from "pusher-js";
-import { PusherChannelMock } from "pusher-js-mock";
+import { Channel, PresenceChannel } from "pusher-js";
+import { PusherChannelMock, PusherPresenceChannelMock } from "pusher-js-mock";
 import { renderHook } from "@testing-library/react-hooks";
 import { useEvent } from "../core/useEvent";
 
@@ -26,4 +26,20 @@ describe("useEvent()", () => {
     channel.emit("event", {});
     expect(listener).not.toHaveBeenCalled();
   });
+
+  /** pusher-js-mock needs to be updated to test this */
+  test.skip("should accept metadata from presence channels", () => {
+    const listener = jest.fn();
+    const channel = new PusherPresenceChannelMock();
+    renderHook(() =>
+      useEvent(
+        (channel as unknown) as PresenceChannel,
+        "presence-event",
+        listener
+      )
+    );
+
+    // @ts-ignore
+    channel.emit("presence-event", {}, { user_id: "my-id" });
+  });
 });

src/core/useEvent.ts

@@ -12,7 +12,7 @@ import { useEffect } from "react";
 export function useEvent<D>(
   channel: Channel | PresenceChannel | undefined,
   eventName: string,
-  callback: (data?: D) => void
+  callback: (data?: D, metadata?: { user_id: string }) => void
 ) {
   // error when required arguments aren't passed.
   invariant(eventName, "Must supply eventName and callback to onEvent");