puppeteer/assets/js/a46e2631.7beacb43.js

/*! For license information please see a46e2631.7beacb43.js.LICENSE.txt */
"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[63706],{14592:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>o});var r=n(85893),s=n(11151);const i={sidebar_label:"EventEmitter"},l="EventEmitter class",a={id:"api/puppeteer.eventemitter",title:"EventEmitter class",description:"The EventEmitter class that many Puppeteer classes extend.",source:"@site/../docs/api/puppeteer.eventemitter.md",sourceDirName:"api",slug:"/api/puppeteer.eventemitter",permalink:"/next/api/puppeteer.eventemitter",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{sidebar_label:"EventEmitter"},sidebar:"api",previous:{title:"TimeoutError",permalink:"/next/api/puppeteer.timeouterror"},next:{title:"EventEmitter.emit",permalink:"/next/api/puppeteer.eventemitter.emit"}},d={},o=[{value:"Signature:",id:"signature",level:4},{value:"Remarks",id:"remarks",level:2},{value:"Methods",id:"methods",level:2}];function c(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",h4:"h4",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"eventemitter-class",children:"EventEmitter class"}),"\n",(0,r.jsx)(t.p,{children:"The EventEmitter class that many Puppeteer classes extend."}),"\n",(0,r.jsx)(t.h4,{id:"signature",children:"Signature:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-typescript",children:"export declare class EventEmitter<Events extends Record<EventType, unknown>> implements CommonEventEmitter<EventsWithWildcard<Events>>\n"})}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"Implements:"})," ",(0,r.jsx)(t.a,{href:"/next/api/puppeteer.commoneventemitter",children:"CommonEventEmitter"}),"<",(0,r.jsx)(t.a,{href:"/next/api/puppeteer.eventswithwildcard",children:"EventsWithWildcard"}),"<Events>>"]}),"\n",(0,r.jsx)(t.h2,{id:"remarks",children:"Remarks"}),"\n",(0,r.jsxs)(t.p,{children:["This allows you to listen to events that Puppeteer classes fire and act accordingly. Therefore you'll mostly use ",(0,r.jsx)(t.a,{href:"/next/api/puppeteer.eventemitter.on",children:"on"})," and ",(0,r.jsx)(t.a,{href:"/next/api/puppeteer.eventemitter.off",children:"off"})," to bind and unbind to event listeners."]}),"\n",(0,r.jsxs)(t.p,{children:["The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ",(0,r.jsx)(t.code,{children:"EventEmitter"})," class."]}),"\n",(0,r.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Method"}),(0,r.jsx)(t.th,{children:"Modifiers"}),(0,r.jsx)(t.th,{children:"Description"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.a,{href:"/next/api/puppeteer.eventemitter.emit",children:"emit(type, event)"})}),(0,r.jsx)(t.td,{}),(0,r.jsx)(t.td,{children:"Emit an event and call any associated listeners."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.a,{href:"/next/api/puppeteer.eventemitter.listenercount",children:"listenerCount(type)"})}),(0,r.jsx)(t.td,{}),(0,r.jsx)(t.td,{children:"Gets the number of listeners for a given event."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.a,{href:"/next/api/puppeteer.eventemitter.off",children:"off(type, handler)"})}),(0,r.jsx)(t.td,{}),(0,r.jsx)(t.td,{children:"Remove an event listener from firing."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.a,{href:"/next/api/puppeteer.eventemitter.on",children:"on(type, handler)"})}),(0,r.jsx)(t.td,{}),(0,r.jsx)(t.td,{children:"Bind an event listener to fire when an event occurs."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.a,{href:"/next/api/puppeteer.eventemitter.once",children:"once(type, handler)"})}),(0,r.jsx)(t.td,{}),(0,r.jsxs)(t.td,{children:["Like ",(0,r.jsx)("code",{chi