Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add example about emitter.emit in events documentation #28374

Closed
wants to merge 8 commits into from
Closed
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions doc/api/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,45 @@ to each.

Returns `true` if the event had listeners, `false` otherwise.


```js
const EventEmitter = require('events');
const myEmitter = new EventEmitter();

// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2}, in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
let parameters = '';
args.forEach((arg) => {
parameters += `${arg}, `;
}
);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please move this closing bracket to the line above. It's otherwise a bit confusing.

It could also be simplified by using join:

  const parameters = args.join(', ');

console.log(`event with parameters ${parameters}in third listener`);
});

console.log(myEmitter.listeners('event'));

myEmitter.emit('event', 1, 2, 3, 4, 5);

// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super tiny nit: the indentation seems off. To keep it aligned with the starting bracket, it needs another whitespace.

// ]

// Helloooo! first listener
// event with parameters 1, 2, in second listener
// event with parameters 1, 2, 3, 4, 5, in third listener
```

### emitter.eventNames()
<!-- YAML
added: v6.0.0
Expand Down