@opentok/client 2.28.4-alpha.8 → 2.28.4

package/README.md

@@ -29,7 +29,7 @@ const OT = require('@opentok/client');
 const publisher = OT.initPublisher();
 ```
 
-Bundle the application with your favourite bundler. For browserify just run:
+Bundle the application with your favorite bundler. For browserify just run:
 
 ```sh
 browserify app.js > bundle.js

package/dist/js/opentok.d.ts

@@ -268,6 +268,85 @@ declare namespace OT {
       context?: object
     ): void;
   }
+  
+  // This class is a modified copy of OTEventEmitter that was needed in order to support the template string used for the signal:type event
+  class SessionOTEventEmitter<EventMap> {
+    on<EventName extends keyof EventMap>(
+      eventName: EventName,
+      callback: (event: EventMap[EventName]) => void,
+      context?: object
+    ): void;
+
+    on(
+      eventName: `signal:${string}`,
+      callback: (event: Event<`signal:${string}`, Session> & {
+        type?: string;
+        data?: string;
+        from: Connection | null;
+      }) => void,
+      context?: object
+    ): void;
+
+    on(
+      eventName: string,
+      callback: (event: Event<string, any>) => void,
+      context?: object
+    ): void;
+
+    on(
+      eventMap: object,
+      context?: object
+    ): void;
+
+    once<EventName extends keyof EventMap>(
+      eventName: EventName,
+      callback: (event: EventMap[EventName]) => void,
+      context?: object
+    ): void;
+
+    once(
+      eventName: `signal:${string}`,
+      callback: (event: Event<`signal:${string}`, Session> & {
+        type?: string;
+        data?: string;
+        from: Connection | null;
+      }) => void,
+      context?: object
+    ): void;
+
+    once(
+      eventName: string,
+      callback: (event: Event<string, any>) => void,
+      context?: object
+    ): void;
+
+    once(
+      eventMap: object,
+      context?: object
+    ): void;
+
+    off<EventName extends keyof EventMap>(
+      eventName?: EventName,
+      callback?: (event: EventMap[EventName]) => void,
+      context?: object
+    ): void;
+
+    off(
+      eventName: `signal:${string}`,
+      context?: object
+    ): void;
+
+    off(
+      eventName?: string,
+      callback?: (event: Event<string, any>) => void,
+      context?: object
+    ): void;
+
+    off(
+      eventMap: object,
+      context?: object
+    ): void;
+  }
 
   export class Publisher extends OTEventEmitter<{
     accessAllowed: Event<'accessAllowed', Publisher>;
@@ -384,7 +463,7 @@ declare namespace OT {
     context?: object
   ): void;
 
-  export class Session extends OTEventEmitter<{
+  export class Session extends SessionOTEventEmitter<{
     archiveStarted: Event<'archiveStarted', Session> & {
       id: string;
       name: string;