Add done event
#63
Add done event
#63
Conversation
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.
src/EventSource.js
Outdated
| 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? :) |
|
@daniel-bryant Thank you for the great work. I hope this gets merged eventually, but in the meantime it 100% solved the problem we were having 🙇♂️ |
|
@quentez that is great to hear, happy to help! |
|
it's not merged into the master branch (not available in the latest release, 1.2.1). how can I use this fix @daniel-bryant ? |
was more of a git/ package management question actually! but pls let me know if there's a better way! |
6 participants
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.