puppeteer/new-docs/puppeteer.eventemitter.md
Jack Franklin ace31d6f58
chore: pin TSDoc related dependencies (#6063)
Without the API-* dependencies pinned different versions may be
installed on local machines vs CI. One of the checks we do is to check
that the checked in docs matches what is generated on CI. Therefore we
need to ensure devs locally run the exact version that CI runs such that
they generate the same output. So in this case we pin to a particular
version of the dependencies.
2020-06-22 09:16:51 +01:00

1.9 KiB

Home > puppeteer > 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.