Typing event emitters (#764)

versatica · Feb 22, 2022 · fe5b3ab · fe5b3ab
1 parent 3615511
commit fe5b3ab
Show file tree

Hide file tree

Showing 50 changed files with 547 additions and 91 deletions.
diff --git a/node/lib/ActiveSpeakerObserver.d.ts b/node/lib/ActiveSpeakerObserver.d.ts
@@ -1,5 +1,6 @@
-import { RtpObserver } from './RtpObserver';
+import { RtpObserver, RtpObserverEvents, RtpObserverObserverEvents } from './RtpObserver';
 import { Producer } from './Producer';
+import { EnhancedEventEmitter } from './EnhancedEventEmitter';
 export interface ActiveSpeakerObserverOptions {
     interval?: number;
     /**
@@ -13,14 +14,25 @@ export interface ActiveSpeakerObserverActivity {
      */
     producer: Producer;
 }
-export declare class ActiveSpeakerObserver extends RtpObserver {
+export declare type ActiveSpeakerObserverEvents = RtpObserverEvents & {
+    dominantspeaker: [{
+        producer: Producer;
+    }];
+};
+export declare type ActiveSpeakerObserverObserverEvents = RtpObserverObserverEvents & {
+    dominantspeaker: [{
+        producer: Producer;
+    }];
+};
+export declare class ActiveSpeakerObserver extends RtpObserver<ActiveSpeakerObserverEvents> {
     /**
      * @private
      */
     constructor(params: any);
     /**
      * Observer.
      */
+    get observer(): EnhancedEventEmitter<ActiveSpeakerObserverObserverEvents>;
     private handleWorkerNotifications;
 }
 //# sourceMappingURL=ActiveSpeakerObserver.d.ts.map
diff --git a/node/lib/ActiveSpeakerObserver.d.ts.map b/node/lib/ActiveSpeakerObserver.d.ts.map
diff --git a/node/lib/ActiveSpeakerObserver.js b/node/lib/ActiveSpeakerObserver.js
@@ -15,7 +15,9 @@ class ActiveSpeakerObserver extends RtpObserver_1.RtpObserver {
     /**
      * Observer.
      */
-    // get observer(): EnhancedEventEmitter
+    get observer() {
+        return super.observer;
+    }
     handleWorkerNotifications() {
         this.channel.on(this.internal.rtpObserverId, (event, data) => {
             switch (event) {

diff --git a/node/lib/AudioLevelObserver.d.ts b/node/lib/AudioLevelObserver.d.ts
@@ -1,5 +1,6 @@
-import { RtpObserver } from './RtpObserver';
+import { RtpObserver, RtpObserverEvents, RtpObserverObserverEvents } from './RtpObserver';
 import { Producer } from './Producer';
+import { EnhancedEventEmitter } from './EnhancedEventEmitter';
 export interface AudioLevelObserverOptions {
     /**
      * Maximum number of entries in the 'volumes”' event. Default 1.
@@ -30,7 +31,15 @@ export interface AudioLevelObserverVolume {
      */
     volume: number;
 }
-export declare class AudioLevelObserver extends RtpObserver {
+export declare type AudioLevelObserverEvents = RtpObserverEvents & {
+    volumes: [AudioLevelObserverVolume[]];
+    silence: [];
+};
+export declare type AudioLevelObserverObserverEvents = RtpObserverObserverEvents & {
+    volumes: [AudioLevelObserverVolume[]];
+    silence: [];
+};
+export declare class AudioLevelObserver extends RtpObserver<AudioLevelObserverEvents> {
     /**
      * @private
      * @emits volumes - (volumes: AudioLevelObserverVolume[])
@@ -48,6 +57,7 @@ export declare class AudioLevelObserver extends RtpObserver {
      * @emits volumes - (volumes: AudioLevelObserverVolume[])
      * @emits silence
      */
+    get observer(): EnhancedEventEmitter<AudioLevelObserverObserverEvents>;
     private handleWorkerNotifications;
 }
 //# sourceMappingURL=AudioLevelObserver.d.ts.map
diff --git a/node/lib/AudioLevelObserver.d.ts.map b/node/lib/AudioLevelObserver.d.ts.map
diff --git a/node/lib/AudioLevelObserver.js b/node/lib/AudioLevelObserver.js
@@ -25,7 +25,9 @@ class AudioLevelObserver extends RtpObserver_1.RtpObserver {
      * @emits volumes - (volumes: AudioLevelObserverVolume[])
      * @emits silence
      */
-    // get observer(): EnhancedEventEmitter
+    get observer() {
+        return super.observer;
+    }
     handleWorkerNotifications() {
         this.channel.on(this.internal.rtpObserverId, (event, data) => {
             switch (event) {

diff --git a/node/lib/Consumer.d.ts b/node/lib/Consumer.d.ts
@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { EnhancedEventEmitter } from './EnhancedEventEmitter';
 import { Channel } from './Channel';
 import { PayloadChannel } from './PayloadChannel';
@@ -123,7 +124,25 @@ export declare type ConsumerStat = {
  * Consumer type.
  */
 export declare type ConsumerType = 'simple' | 'simulcast' | 'svc' | 'pipe';
-export declare class Consumer extends EnhancedEventEmitter {
+export declare type ConsumerEvents = {
+    transportclose: [];
+    producerclose: [];
+    producerpause: [];
+    producerresume: [];
+    score: [ConsumerScore];
+    layerschange: [ConsumerLayers?];
+    trace: [ConsumerTraceEventData];
+    rtp: [Buffer];
+};
+export declare type ConsumerObserverEvents = {
+    close: [];
+    pause: [];
+    resume: [];
+    score: [ConsumerScore];
+    layerschange: [ConsumerLayers?];
+    trace: [ConsumerTraceEventData];
+};
+export declare class Consumer extends EnhancedEventEmitter<ConsumerEvents> {
     #private;
     /**
      * @private
@@ -215,7 +234,7 @@ export declare class Consumer extends EnhancedEventEmitter {
      * @emits layerschange - (layers: ConsumerLayers | undefined)
      * @emits trace - (trace: ConsumerTraceEventData)
      */
-    get observer(): EnhancedEventEmitter;
+    get observer(): EnhancedEventEmitter<ConsumerObserverEvents>;
     /**
      * @private
      * Just for testing purposes.

diff --git a/node/lib/Consumer.d.ts.map b/node/lib/Consumer.d.ts.map
diff --git a/node/lib/DataConsumer.d.ts b/node/lib/DataConsumer.d.ts
@@ -47,7 +47,17 @@ export declare type DataConsumerStat = {
  * DataConsumer type.
  */
 export declare type DataConsumerType = 'sctp' | 'direct';
-export declare class DataConsumer extends EnhancedEventEmitter {
+export declare type DataConsumerEvents = {
+    transportclose: [];
+    dataproducerclose: [];
+    message: [Buffer, number];
+    sctpsendbufferfull: [];
+    bufferedamountlow: [number];
+};
+export declare type DataConsumerObserverEvents = {
+    close: [];
+};
+export declare class DataConsumer extends EnhancedEventEmitter<DataConsumerEvents> {
     #private;
     /**
      * @private
@@ -107,7 +117,7 @@ export declare class DataConsumer extends EnhancedEventEmitter {
      *
      * @emits close
      */
-    get observer(): EnhancedEventEmitter;
+    get observer(): EnhancedEventEmitter<DataConsumerObserverEvents>;
     /**
      * Close the DataConsumer.
      */