Add done event
#63
Open
Add done event
#63
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
EmilJunker
reviewed
Aug 2, 2024
README.md
Outdated
| ### Done vs Close | ||
|
|
||
| `done` events will fire when server closes the connection. | ||
| Reconnections will occur indefinitely, unless this behavior is disabled. |
There was a problem hiding this comment.
I think this should be rephrased slightly to make it more clear. Maybe something like:
By default, the client will automatically reconnect when this happens. You can disable the reconnections by setting the pollingInterval option to 0".
There was a problem hiding this comment.
Sounds good to me. Updated.
EmilJunker
reviewed
Aug 3, 2024
src/EventSource.js
Outdated
| @@ -115,6 +116,7 @@ class EventSource { | |||
| this._handleEvent(xhr.responseText || ''); | |||
|
|
|||
| if (xhr.readyState === XMLHttpRequest.DONE) { | |||
| this.dispatch('done', { type: 'done' }); | |||
There was a problem hiding this comment.
I would strongly recommend to dispatch the done event after calling _pollAgain. This would allow users to cancel the reconnection by calling .close() from the done handler.
There was a problem hiding this comment.
Good call. I just updated and tested that it works as expected.
This allows 'close' called from a 'done' handler to cancel the upcoming reconnection. Otherwise '_pollTimer' will get reset after the handler.
|
LGTM 👍 |
|
any idea when this will merge? :) |
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.
See my original issue #56 for some background.
Currently the library only supports
closeevents, which fire when the connection is closed from the client side. An additional event for tracking server side closing of the connection would be useful. This PR adds adoneevent to do that. Luckily most of the plumbing is already there, so it was easy to hook up the new event. As far as naming goes, I just matched the state name like most other events seem to do. It still might be a little confusing, so I added some text to the README.