-
Notifications
You must be signed in to change notification settings - Fork 30k
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
Closed
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
46ae972
doc: add example about emitter.emit in events documentation
felipedc09 de07417
modify emitter.emit example to simplify the use
felipedc09 5ab4be1
fix lint exceptions
felipedc09 5c1bb28
formating prints
felipedc09 924c547
fix spaces to run lint
felipedc09 2524a00
Update events.md
Trott 566f830
Update events.md
Trott 489dcde
Update events.md
Trott File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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}, `; | ||
} | ||
); | ||
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] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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
: