Skip to content

Commit f3c87dc

Browse files
authored
chore: upgrade mitt (#9340)
1 parent e8c1d56 commit f3c87dc

11 files changed

+48
-44
lines changed

docs/api/puppeteer.eventemitter.addlistener.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,16 @@ Add an event listener.
1414

1515
```typescript
1616
class EventEmitter {
17-
addListener(event: EventType, handler: Handler): EventEmitter;
17+
addListener(event: EventType, handler: Handler<any>): EventEmitter;
1818
}
1919
```
2020

2121
## Parameters
2222

23-
| Parameter | Type | Description |
24-
| --------- | ------------------------------------- | ----------- |
25-
| event | [EventType](./puppeteer.eventtype.md) | |
26-
| handler | [Handler](./puppeteer.handler.md) | |
23+
| Parameter | Type | Description |
24+
| --------- | -------------------------------------------- | ----------- |
25+
| event | [EventType](./puppeteer.eventtype.md) | |
26+
| handler | [Handler](./puppeteer.handler.md)&lt;any&gt; | |
2727

2828
**Returns:**
2929

docs/api/puppeteer.eventemitter.off.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ Remove an event listener from firing.
1010

1111
```typescript
1212
class EventEmitter {
13-
off(event: EventType, handler: Handler): EventEmitter;
13+
off(event: EventType, handler: Handler<any>): EventEmitter;
1414
}
1515
```
1616

1717
## Parameters
1818

19-
| Parameter | Type | Description |
20-
| --------- | ------------------------------------- | ----------------------------------------------- |
21-
| event | [EventType](./puppeteer.eventtype.md) | the event type you'd like to stop listening to. |
22-
| handler | [Handler](./puppeteer.handler.md) | the function that should be removed. |
19+
| Parameter | Type | Description |
20+
| --------- | -------------------------------------------- | ----------------------------------------------- |
21+
| event | [EventType](./puppeteer.eventtype.md) | the event type you'd like to stop listening to. |
22+
| handler | [Handler](./puppeteer.handler.md)&lt;any&gt; | the function that should be removed. |
2323

2424
**Returns:**
2525

docs/api/puppeteer.eventemitter.on.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ Bind an event listener to fire when an event occurs.
1010

1111
```typescript
1212
class EventEmitter {
13-
on(event: EventType, handler: Handler): EventEmitter;
13+
on(event: EventType, handler: Handler<any>): EventEmitter;
1414
}
1515
```
1616

1717
## Parameters
1818

19-
| Parameter | Type | Description |
20-
| --------- | ------------------------------------- | ------------------------------------------------------------------ |
21-
| event | [EventType](./puppeteer.eventtype.md) | the event type you'd like to listen to. Can be a string or symbol. |
22-
| handler | [Handler](./puppeteer.handler.md) | the function to be called when the event occurs. |
19+
| Parameter | Type | Description |
20+
| --------- | -------------------------------------------- | ------------------------------------------------------------------ |
21+
| event | [EventType](./puppeteer.eventtype.md) | the event type you'd like to listen to. Can be a string or symbol. |
22+
| handler | [Handler](./puppeteer.handler.md)&lt;any&gt; | the function to be called when the event occurs. |
2323

2424
**Returns:**
2525

docs/api/puppeteer.eventemitter.once.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ Like `on` but the listener will only be fired once and then it will be removed.
1010

1111
```typescript
1212
class EventEmitter {
13-
once(event: EventType, handler: Handler): EventEmitter;
13+
once(event: EventType, handler: Handler<any>): EventEmitter;
1414
}
1515
```
1616

1717
## Parameters
1818

19-
| Parameter | Type | Description |
20-
| --------- | ------------------------------------- | ------------------------------------------------- |
21-
| event | [EventType](./puppeteer.eventtype.md) | the event you'd like to listen to |
22-
| handler | [Handler](./puppeteer.handler.md) | the handler function to run when the event occurs |
19+
| Parameter | Type | Description |
20+
| --------- | -------------------------------------------- | ------------------------------------------------- |
21+
| event | [EventType](./puppeteer.eventtype.md) | the event you'd like to listen to |
22+
| handler | [Handler](./puppeteer.handler.md)&lt;any&gt; | the handler function to run when the event occurs |
2323

2424
**Returns:**
2525

docs/api/puppeteer.eventemitter.removelistener.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,16 @@ Remove an event listener.
1414

1515
```typescript
1616
class EventEmitter {
17-
removeListener(event: EventType, handler: Handler): EventEmitter;
17+
removeListener(event: EventType, handler: Handler<any>): EventEmitter;
1818
}
1919
```
2020

2121
## Parameters
2222

23-
| Parameter | Type | Description |
24-
| --------- | ------------------------------------- | ----------- |
25-
| event | [EventType](./puppeteer.eventtype.md) | |
26-
| handler | [Handler](./puppeteer.handler.md) | |
23+
| Parameter | Type | Description |
24+
| --------- | -------------------------------------------- | ----------- |
25+
| event | [EventType](./puppeteer.eventtype.md) | |
26+
| handler | [Handler](./puppeteer.handler.md)&lt;any&gt; | |
2727

2828
**Returns:**
2929

docs/api/puppeteer.handler.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ sidebar_label: Handler
77
#### Signature:
88

99
```typescript
10-
declare type Handler<T = any> = (event?: T) => void;
10+
declare type Handler<T = unknown> = (event: T) => void;
1111
```

package-lock.json

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@
8181
"jpeg-js": "0.4.4",
8282
"mime": "3.0.0",
8383
"minimist": "1.2.6",
84-
"mitt": "2.1.0",
84+
"mitt": "3.0.0",
8585
"mocha": "10.0.0",
8686
"ncp": "2.0.0",
8787
"npm-run-all": "4.1.5",

packages/puppeteer-core/src/api/Page.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,7 @@ export interface PageEventObject {
425425
* @public
426426
*/
427427
export class Page extends EventEmitter {
428-
#handlerMap = new WeakMap<Handler, Handler>();
428+
#handlerMap = new WeakMap<Handler<any>, Handler<any>>();
429429

430430
/**
431431
* @internal

packages/puppeteer-core/src/common/EventEmitter.ts

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
import mitt, {
1818
Emitter,
1919
EventType,
20+
EventHandlerMap,
2021
Handler,
2122
} from '../../third_party/mitt/index.js';
2223

@@ -57,8 +58,8 @@ export interface CommonEventEmitter {
5758
* @public
5859
*/
5960
export class EventEmitter implements CommonEventEmitter {
60-
private emitter: Emitter;
61-
private eventsMap = new Map<EventType, Handler[]>();
61+
private emitter: Emitter<Record<string | symbol, any>>;
62+
private eventsMap: EventHandlerMap<Record<string | symbol, any>> = new Map();
6263

6364
/**
6465
* @internal
@@ -73,7 +74,7 @@ export class EventEmitter implements CommonEventEmitter {
7374
* @param handler - the function to be called when the event occurs.
7475
* @returns `this` to enable you to chain method calls.
7576
*/
76-
on(event: EventType, handler: Handler): EventEmitter {
77+
on(event: EventType, handler: Handler<any>): EventEmitter {
7778
this.emitter.on(event, handler);
7879
return this;
7980
}
@@ -84,7 +85,7 @@ export class EventEmitter implements CommonEventEmitter {
8485
* @param handler - the function that should be removed.
8586
* @returns `this` to enable you to chain method calls.
8687
*/
87-
off(event: EventType, handler: Handler): EventEmitter {
88+
off(event: EventType, handler: Handler<any>): EventEmitter {
8889
this.emitter.off(event, handler);
8990
return this;
9091
}
@@ -93,7 +94,7 @@ export class EventEmitter implements CommonEventEmitter {
9394
* Remove an event listener.
9495
* @deprecated please use {@link EventEmitter.off} instead.
9596
*/
96-
removeListener(event: EventType, handler: Handler): EventEmitter {
97+
removeListener(event: EventType, handler: Handler<any>): EventEmitter {
9798
this.off(event, handler);
9899
return this;
99100
}
@@ -102,7 +103,7 @@ export class EventEmitter implements CommonEventEmitter {
102103
* Add an event listener.
103104
* @deprecated please use {@link EventEmitter.on} instead.
104105
*/
105-
addListener(event: EventType, handler: Handler): EventEmitter {
106+
addListener(event: EventType, handler: Handler<any>): EventEmitter {
106107
this.on(event, handler);
107108
return this;
108109
}
@@ -125,8 +126,8 @@ export class EventEmitter implements CommonEventEmitter {
125126
* @param handler - the handler function to run when the event occurs
126127
* @returns `this` to enable you to chain method calls.
127128
*/
128-
once(event: EventType, handler: Handler): EventEmitter {
129-
const onceHandler: Handler = eventData => {
129+
once(event: EventType, handler: Handler<any>): EventEmitter {
130+
const onceHandler: Handler<any> = eventData => {
130131
handler(eventData);
131132
this.off(event, onceHandler);
132133
};

test/src/CDPSession.spec.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,10 @@ describe('Target.createCDPSession', function () {
6464
client.on('Network.requestWillBeSent', event => {
6565
return events.push(event);
6666
});
67-
await page.goto(server.EMPTY_PAGE);
67+
await Promise.all([
68+
waitEvent(client, 'Network.requestWillBeSent'),
69+
page.goto(server.EMPTY_PAGE),
70+
]);
6871
expect(events.length).toBe(1);
6972
});
7073
it('should enable and disable domains independently', async () => {

0 commit comments

Comments
 (0)