puppeteer/docs/api/puppeteer.eventemitter.emit.md
jrandolf f07ad2c661
fix: update documentation on configuring puppeteer (#9150)
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
2022-10-24 09:07:05 +02:00

29 lines
805 B
Markdown

---
sidebar_label: EventEmitter.emit
---
# EventEmitter.emit() method
Emit an event and call any associated listeners.
#### Signature:
```typescript
class EventEmitter {
emit(event: EventType, eventData?: unknown): boolean;
}
```
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------- | ------------------------------------------------------------ |
| event | [EventType](./puppeteer.eventtype.md) | the event you'd like to emit |
| eventData | unknown | <i>(Optional)</i> any data you'd like to emit with the event |
**Returns:**
boolean
`true` if there are any listeners, `false` if there are not.