refactor!: remove add/removeEventListener in favor of on/off (#11792)

puppeteer · Feb 2, 2024 · f160874 · f160874
1 parent d4e9d8d
commit f160874
Show file tree

Hide file tree

Showing 8 changed files with 10 additions and 174 deletions.
diff --git a/docs/api/puppeteer.commoneventemitter.addlistener.md b/docs/api/puppeteer.commoneventemitter.addlistener.md
diff --git a/docs/api/puppeteer.commoneventemitter.md b/docs/api/puppeteer.commoneventemitter.md
@@ -14,11 +14,9 @@ export interface CommonEventEmitter<Events extends Record<EventType, unknown>>
 
 | Method                                                                            | Description |
 | --------------------------------------------------------------------------------- | ----------- |
-| [addListener(type, handler)](./puppeteer.commoneventemitter.addlistener.md)       |             |
 | [emit(type, event)](./puppeteer.commoneventemitter.emit.md)                       |             |
 | [listenerCount(event)](./puppeteer.commoneventemitter.listenercount.md)           |             |
 | [off(type, handler)](./puppeteer.commoneventemitter.off.md)                       |             |
 | [on(type, handler)](./puppeteer.commoneventemitter.on.md)                         |             |
 | [once(type, handler)](./puppeteer.commoneventemitter.once.md)                     |             |
 | [removeAllListeners(event)](./puppeteer.commoneventemitter.removealllisteners.md) |             |
-| [removeListener(type, handler)](./puppeteer.commoneventemitter.removelistener.md) |             |
diff --git a/docs/api/puppeteer.commoneventemitter.removelistener.md b/docs/api/puppeteer.commoneventemitter.removelistener.md
diff --git a/docs/api/puppeteer.eventemitter.addlistener.md b/docs/api/puppeteer.eventemitter.addlistener.md
diff --git a/docs/api/puppeteer.eventemitter.md b/docs/api/puppeteer.eventemitter.md
@@ -22,13 +22,11 @@ The constructor for this class is marked as internal. Third-party code should no
 
 ## Methods
 
-| Method                                                                      | Modifiers | Description                                                                                      |
-| --------------------------------------------------------------------------- | --------- | ------------------------------------------------------------------------------------------------ |
-| [addListener(type, handler)](./puppeteer.eventemitter.addlistener.md)       |           | Add an event listener.                                                                           |
-| [emit(type, event)](./puppeteer.eventemitter.emit.md)                       |           | Emit an event and call any associated listeners.                                                 |
-| [listenerCount(type)](./puppeteer.eventemitter.listenercount.md)            |           | Gets the number of listeners for a given event.                                                  |
-| [off(type, handler)](./puppeteer.eventemitter.off.md)                       |           | Remove an event listener from firing.                                                            |
-| [on(type, handler)](./puppeteer.eventemitter.on.md)                         |           | Bind an event listener to fire when an event occurs.                                             |
-| [once(type, handler)](./puppeteer.eventemitter.once.md)                     |           | Like <code>on</code> but the listener will only be fired once and then it will be removed.       |
-| [removeAllListeners(type)](./puppeteer.eventemitter.removealllisteners.md)  |           | Removes all listeners. If given an event argument, it will remove only listeners for that event. |
-| [removeListener(type, handler)](./puppeteer.eventemitter.removelistener.md) |           | Remove an event listener.                                                                        |
+| Method                                                                     | Modifiers | Description                                                                                      |
+| -------------------------------------------------------------------------- | --------- | ------------------------------------------------------------------------------------------------ |
+| [emit(type, event)](./puppeteer.eventemitter.emit.md)                      |           | Emit an event and call any associated listeners.                                                 |
+| [listenerCount(type)](./puppeteer.eventemitter.listenercount.md)           |           | Gets the number of listeners for a given event.                                                  |
+| [off(type, handler)](./puppeteer.eventemitter.off.md)                      |           | Remove an event listener from firing.                                                            |
+| [on(type, handler)](./puppeteer.eventemitter.on.md)                        |           | Bind an event listener to fire when an event occurs.                                             |
+| [once(type, handler)](./puppeteer.eventemitter.once.md)                    |           | Like <code>on</code> but the listener will only be fired once and then it will be removed.       |
+| [removeAllListeners(type)](./puppeteer.eventemitter.removealllisteners.md) |           | Removes all listeners. If given an event argument, it will remove only listeners for that event. |
diff --git a/docs/api/puppeteer.eventemitter.removelistener.md b/docs/api/puppeteer.eventemitter.removelistener.md
diff --git a/packages/puppeteer-core/src/common/EventEmitter.test.ts b/packages/puppeteer-core/src/common/EventEmitter.test.ts
@@ -19,7 +19,7 @@ describe('EventEmitter', () => {
   });
 
   describe('on', () => {
-    const onTests = (methodName: 'on' | 'addListener'): void => {
+    const onTests = (methodName: 'on'): void => {
       it(`${methodName}: adds an event listener that is fired when the event is emitted`, () => {
         const listener = sinon.spy();
         emitter[methodName]('foo', listener);
@@ -43,12 +43,10 @@ describe('EventEmitter', () => {
       });
     };
     onTests('on');
-    // we support addListener for legacy reasons
-    onTests('addListener');
   });
 
   describe('off', () => {
-    const offTests = (methodName: 'off' | 'removeListener'): void => {
+    const offTests = (methodName: 'off'): void => {
       it(`${methodName}: removes the listener so it is no longer called`, () => {
         const listener = sinon.spy();
         emitter.on('foo', listener);
@@ -67,8 +65,6 @@ describe('EventEmitter', () => {
       });
     };
     offTests('off');
-    // we support removeListener for legacy reasons
-    offTests('removeListener');
   });
 
   describe('once', () => {

diff --git a/packages/puppeteer-core/src/common/EventEmitter.ts b/packages/puppeteer-core/src/common/EventEmitter.ts
@@ -27,18 +27,6 @@ export interface CommonEventEmitter<Events extends Record<EventType, unknown>> {
     handler?: Handler<Events[Key]>
   ): this;
   emit<Key extends keyof Events>(type: Key, event: Events[Key]): boolean;
-  /* To maintain parity with the built in NodeJS event emitter which uses removeListener
-   * rather than `off`.
-   * If you're implementing new code you should use `off`.
-   */
-  addListener<Key extends keyof Events>(
-    type: Key,
-    handler: Handler<Events[Key]>
-  ): this;
-  removeListener<Key extends keyof Events>(
-    type: Key,
-    handler: Handler<Events[Key]>
-  ): this;
   once<Key extends keyof Events>(
     type: Key,
     handler: Handler<Events[Key]>
@@ -148,30 +136,6 @@ export class EventEmitter<Events extends Record<EventType, unknown>>
     return this.listenerCount(type) > 0;
   }
 
-  /**
-   * Remove an event listener.
-   *
-   * @deprecated please use {@link EventEmitter.off} instead.
-   */
-  removeListener<Key extends keyof EventsWithWildcard<Events>>(
-    type: Key,
-    handler: Handler<EventsWithWildcard<Events>[Key]>
-  ): this {
-    return this.off(type, handler);
-  }
-
-  /**
-   * Add an event listener.
-   *
-   * @deprecated please use {@link EventEmitter.on} instead.
-   */
-  addListener<Key extends keyof EventsWithWildcard<Events>>(
-    type: Key,
-    handler: Handler<EventsWithWildcard<Events>[Key]>
-  ): this {
-    return this.on(type, handler);
-  }
-
   /**
    * Like `on` but the listener will only be fired once and then it will be removed.
    * @param type - the event you'd like to listen to