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

Documentation doesn't mention listeners can return false #70

Open
Sjeiti opened this issue Sep 28, 2016 · 1 comment
Open

Documentation doesn't mention listeners can return false #70

Sjeiti opened this issue Sep 28, 2016 · 1 comment

Comments

@Sjeiti
Copy link

Sjeiti commented Sep 28, 2016

The documentation doesn't mention listeners returning false will stop execution of subsequent listeners. I had to find out by debugging and digging through the code.

The jsdoc on the add method should be updated to something like

* @param {Function} listener Signal handler function. When a listener returns false, subsequent listeners are not executed.

(I could create a pull request but that's a bit overkill for such a small change, plus I would not be able to run the shell script to update the documentation anyway)

@ghost
Copy link

ghost commented Jan 13, 2017

That'd be a good change.

It is documented over in the examples, but it would be best if it was in both places.

Stop/Halt Propagation (method 2)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant