f07ad2c661
This PR updates the docs regarding configuring puppeteer. In addition, some changes have been made to the documentation generator to show default values on the documentation site. Also fixes: https://github.com/puppeteer/puppeteer/pull/9144
2.6 KiB
2.6 KiB
| sidebar_label |
|---|
| EventEmitter |
EventEmitter class
The EventEmitter class that many Puppeteer classes extend.
Signature:
export declare class EventEmitter implements CommonEventEmitter
Implements: CommonEventEmitter
Remarks
This allows you to listen to events that Puppeteer classes fire and act accordingly. Therefore you'll mostly use on and off to bind and unbind to event listeners.
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the EventEmitter class.
Methods
| Method | Modifiers | Description |
|---|---|---|
| addListener(event, handler) | Add an event listener. | |
| emit(event, eventData) | Emit an event and call any associated listeners. | |
| listenerCount(event) | Gets the number of listeners for a given event. | |
| off(event, handler) | Remove an event listener from firing. | |
| on(event, handler) | Bind an event listener to fire when an event occurs. | |
| once(event, handler) | Like on but the listener will only be fired once and then it will be removed. |
|
| removeAllListeners(event) | Removes all listeners. If given an event argument, it will remove only listeners for that event. | |
| removeListener(event, handler) | Remove an event listener. |