Merge pull request #448 from hendrikheil/feat/allow-checking-echo-configured

feat(vue): allow checking if echo is configured

Author: joetannenbaum

packages/react/src/config/index.ts

@@ -82,3 +82,5 @@ export const configureEcho = <T extends BroadcastDriver>(
 
 export const echo = <T extends BroadcastDriver>(): Echo<T> =>
     getEchoInstance<T>();
+
+export const echoIsConfigured = () => echoConfig !== null;

packages/react/src/index.ts

@@ -1,4 +1,4 @@
-export { configureEcho, echo } from "./config/index";
+export { configureEcho, echo, echoIsConfigured } from "./config/index";
 export {
     useEcho,
     useEchoModel,

packages/react/tests/config.test.ts

@@ -1,21 +1,38 @@
 import { beforeEach, describe, expect, it, vi } from "vitest";
-import { configureEcho, echo } from "../src";
 
-describe("echo helper", async () => {
+describe("echo helper", () => {
     beforeEach(() => {
         vi.resetModules();
     });
 
     it("throws error when Echo is not configured", async () => {
+        const { echo } = await import("../src/config");
+
         expect(() => echo()).toThrow("Echo has not been configured");
     });
 
     it("creates Echo instance with proper configuration", async () => {
+        const { configureEcho, echo } = await import("../src/config");
+
         configureEcho({
             broadcaster: "null",
         });
 
         expect(echo()).toBeDefined();
         expect(echo().options.broadcaster).toBe("null");
     });
+
+    it("checks if Echo is configured", async () => {
+        const { configureEcho, echoIsConfigured } = await import(
+            "../src/config"
+        );
+
+        expect(echoIsConfigured()).toBe(false);
+
+        configureEcho({
+            broadcaster: "null",
+        });
+
+        expect(echoIsConfigured()).toBe(true);
+    });
 });

packages/vue/src/config/index.ts

@@ -23,6 +23,8 @@ const getEchoInstance = <T extends BroadcastDriver>(): Echo<T> => {
     return echoInstance as Echo<T>;
 };
 
+export const echoIsConfigured = () => echoConfig !== null;
+
 /**
  * Configure the Echo instance with sensible defaults.
  *

packages/vue/src/index.ts

@@ -5,4 +5,4 @@ export {
     useEchoPresence,
     useEchoPublic,
 } from "./composables/useEcho";
-export { configureEcho, echo } from "./config/index";
+export { configureEcho, echo, echoIsConfigured } from "./config/index";

packages/vue/tests/config.test.ts

@@ -1,5 +1,4 @@
 import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-import { configureEcho, echo } from "../src/config";
 
 describe("echo helper", async () => {
     beforeEach(() => {
@@ -11,14 +10,31 @@ describe("echo helper", async () => {
     });
 
     it("throws error when Echo is not configured", async () => {
+        const { echo } = await import("../src/config");
+
         expect(() => echo()).toThrow("Echo has not been configured");
     });
 
     it("creates Echo instance with proper configuration", async () => {
+        const { configureEcho, echo } = await import("../src/config");
+
         configureEcho({
             broadcaster: "null",
         });
 
         expect(echo()).toBeDefined();
     });
+
+    it("checks if Echo is configured", async () => {
+        const { configureEcho, echoIsConfigured: echoIsConfigured } =
+            await import("../src/config");
+
+        expect(echoIsConfigured()).toBe(false);
+
+        configureEcho({
+            broadcaster: "null",
+        });
+
+        expect(echoIsConfigured()).toBe(true);
+    });
 });