Consistent event arguments and documentation #69
Merged
Conversation
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
WyriHaximus
approved these changes
Mar 3, 2017
jsor
requested changes
Mar 3, 2017
README.md
Outdated
| @@ -18,9 +18,11 @@ This component depends on `événement`, which is an implementation of the | |||
|
|
|||
| ### EventEmitter Events | |||
|
|
|||
| * `data`: Emitted whenever data was read from the source. | |||
| * `data`: Emitted whenever data was read from the source | |||
| with a single mixed argument for incoming data. | |||
| * `end`: Emitted when the source has reached the `eof`. | |||
| * `error`: Emitted when an error occurs. | |||
There was a problem hiding this comment.
Superfluous . after occurs. Also, probably remove the linebreak?
There was a problem hiding this comment.
There you go! 
:-)
I've left the linebreak, as it does not show up in the rendered output and helps keeping the diff smaller. I'll file a follow-up PR that re-structures the documentation soon 👍
src/ReadableStreamInterface.php
Outdated
| @@ -5,9 +5,9 @@ | |||
| use Evenement\EventEmitterInterface; | |||
|
|
|||
| /** | |||
| * @event data | |||
| * @event data with single mixed argument for incoming data | |||
src/ReadableStreamInterface.php
Outdated
| * @event end | ||
| * @event error | ||
| * @event error with single Exception argument for error instance |
src/WritableStreamInterface.php
Outdated
| @@ -6,9 +6,9 @@ | |||
|
|
|||
| /** | |||
| * @event drain | |||
| * @event error | |||
| * @event error with single Exeption argument for error instance | |||
src/WritableStreamInterface.php
Outdated
| * @event close | ||
| * @event pipe | ||
| * @event pipe with single ReadableStreamInterface argument for source stream |
jsor
approved these changes
Mar 3, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This simple PR changes it so that we only emit event arguments that are actually part of the event, i.e. we no longer emit the instance this event was emitted on. This was actually an undocumented feature, so some component may have relied on this.
Among others, this fixes several issues because these instance where never emitted consistently in the first place. In particular, the
forwardEventshelper is used throughout React's ecosystem and has never actually updated the instances, as it has never checked any of the event arguments.I've updated the documentation to now explicitly state which arguments are actually passed to the event handlers.
Not passing these unneeded instances also helps with improving performance slightly. On my system, the benchmark examples went from ~1980 MiB/s to ~2020 MiB/s.
In case the instance the event was emitted on is needed, use a closure and pass it in manually.
Note that this is potentially a BC break in case anybody relied on the undocumented event arguments.