DX improvments by adding typehints

src/connector/connector.ts

@@ -1,10 +1,28 @@
 import { Channel, PresenceChannel } from './../channel';
 
+type CustomConnector = new (options: Options) => Connector;
+
+type Broadcaster = 'socket.io' | 'pusher' | 'null' | CustomConnector
+
+export interface Options {
+    auth?: {
+        headers: Record<string, string>
+    },
+    userAuthentication?: {
+        endpoint?: string,
+        headers?: Record<string, string>,
+    },
+    broadcaster?: Broadcaster,
+    csrfToken?: string | null,
+    bearerToken?: string | null,
+    [K: string]: unknown
+}
+
 export abstract class Connector {
     /**
      * Default connector options.
      */
-    private _defaultOptions: any = {
+    private _defaultOptions: Options = {
         auth: {
             headers: {},
         },
@@ -29,15 +47,15 @@ export abstract class Connector {
     /**
      * Create a new class instance.
      */
-    constructor(options: any) {
+    constructor(options: Options) {
         this.setOptions(options);
         this.connect();
     }
 
     /**
      * Merge the custom options with the defaults.
      */
-    protected setOptions(options: any): any {
+    protected setOptions(options: Options): any {
         this.options = Object.assign(this._defaultOptions, options);
 
         let token = this.csrfToken();
@@ -83,6 +101,11 @@ export abstract class Connector {
      */
     abstract connect(): void;
 
+    /**
+     * Listen for an event on a channel instance.
+     */
+    abstract listen(name: string, event: string, callback: CallableFunction): Channel;
+
     /**
      * Get a channel instance by name.
      */

src/connector/null-connector.ts

@@ -38,6 +38,13 @@ export class NullConnector extends Connector {
         return new NullPrivateChannel();
     }
 
+    /**
+     * Get a private encrypted channel instance by name.
+     */
+    encryptedPrivateChannel(name: string): NullPrivateChannel {
+        return this.privateChannel(name);
+    }
+
     /**
      * Get a presence channel instance by name.
      */

src/connector/socketio-connector.ts

@@ -50,7 +50,7 @@ export class SocketIoConnector extends Connector {
     /**
      * Listen for an event on a channel instance.
      */
-    listen(name: string, event: string, callback: Function): SocketIoChannel {
+    listen(name: string, event: string, callback: CallableFunction): SocketIoChannel {
         return this.channel(name).listen(event, callback);
     }
 

src/echo.ts

@@ -1,24 +1,29 @@
 import { Channel, PresenceChannel } from './channel';
 import { PusherConnector, SocketIoConnector, NullConnector } from './connector';
+import type { Connector, Options } from './connector';
+
+interface EchoOptions extends Options {
+    withoutInterceptors?: boolean;
+}
 
 /**
  * This class is the primary API for interacting with broadcasting.
  */
-export default class Echo {
+export default class Echo<O extends Record<PropertyKey, unknown>> {
     /**
      * The broadcasting connector.
      */
-    connector: any;
+    connector: Connector;
 
     /**
      * The Echo options.
      */
-    options: any;
+    options: EchoOptions & O;
 
     /**
      * Create a new class instance.
      */
-    constructor(options: any) {
+    constructor(options: EchoOptions & O) {
         this.options = options;
         this.connect();
 
@@ -46,6 +51,8 @@ export default class Echo {
             this.connector = new NullConnector(this.options);
         } else if (typeof this.options.broadcaster == 'function') {
             this.connector = new this.options.broadcaster(this.options);
+        } else {
+            throw new Error('Broadcaster option not set when initialising Echo.');
         }
     }
 
@@ -95,7 +102,7 @@ export default class Echo {
      * Get a private encrypted channel instance by name.
      */
     encryptedPrivate(channel: string): Channel {
-        return this.connector.encryptedPrivateChannel(channel);
+        return (this.connector as NullConnector | PusherConnector).encryptedPrivateChannel(channel);
     }
 
     /**
@@ -106,8 +113,8 @@ export default class Echo {
     }
 
     /**
-     * Register 3rd party request interceptiors. These are used to automatically
-     * send a connections socket id to a Laravel app with a X-Socket-Id header.
+     * Register 3rd party request interceptors. These are used to automatically
+     * send a connections socket id to a Laravel app with an X-Socket-Id header.
      */
     registerInterceptors(): void {
         if (typeof Vue === 'function' && Vue.http) {
@@ -179,4 +186,4 @@ export default class Echo {
 /**
  * Export channel classes for TypeScript.
  */
-export { Channel, PresenceChannel };
+export { Channel, PresenceChannel, EchoOptions };