Merge pull request #437 from laravel/fix-channel-return-type

Fix channel return type

Author: joetannenbaum

packages/react/src/hooks/use-echo.ts

@@ -4,6 +4,7 @@ import { echo } from "../config";
 import type {
     Channel,
     ChannelData,
+    ChannelReturnType,
     Connection,
     ModelEvents,
     ModelPayload,
@@ -157,7 +158,8 @@ export const useEcho = <
         /**
          * Channel instance
          */
-        channel: () => subscription.current,
+        channel: () =>
+            subscription.current as ChannelReturnType<TDriver, TVisibility>,
     };
 };
 

packages/react/src/types.ts

@@ -16,6 +16,15 @@ export type Channel = {
     visibility: "private" | "public" | "presence";
 };
 
+export type ChannelReturnType<
+    T extends BroadcastDriver,
+    V extends Channel["visibility"],
+> = V extends "presence"
+    ? Broadcaster[T]["presence"]
+    : V extends "private"
+      ? Broadcaster[T]["private"]
+      : Broadcaster[T]["public"];
+
 export type ConfigDefaults<O extends BroadcastDriver> = Record<
     O,
     Broadcaster[O]["options"]

packages/vue/src/composables/useEcho.ts

@@ -4,6 +4,7 @@ import { echo } from "../config";
 import type {
     Channel,
     ChannelData,
+    ChannelReturnType,
     Connection,
     ModelEvents,
     ModelPayload,
@@ -173,7 +174,7 @@ export const useEcho = <
         /**
          * Channel instance
          */
-        channel: () => subscription,
+        channel: () => subscription as ChannelReturnType<TDriver, TVisibility>,
     };
 };
 

packages/vue/src/types.ts

@@ -16,6 +16,15 @@ export type Channel = {
     visibility: "private" | "public" | "presence";
 };
 
+export type ChannelReturnType<
+    T extends BroadcastDriver,
+    V extends Channel["visibility"],
+> = V extends "presence"
+    ? Broadcaster[T]["presence"]
+    : V extends "private"
+      ? Broadcaster[T]["private"]
+      : Broadcaster[T]["public"];
+
 export type ConfigDefaults<O extends BroadcastDriver> = Record<
     O,
     Broadcaster[O]["options"]