Merge branch 'add-done-event'

Author: wojciechkrol

README.md

@@ -51,11 +51,24 @@ es.addEventListener("error", (event) => {
   }
 });
 
+es.addEventListener("done", (event) => {
+  console.log("Done SSE connection.");
+});
+
 es.addEventListener("close", (event) => {
   console.log("Close SSE connection.");
 });
 ```
 
+### Done vs Close
+
+`done` events will fire when server closes the connection.
+By default, the client will automatically reconnect when this happens.
+You can disable reconnections by setting the `pollingInterval` option to `0`.
+`close` events will fire when the connection is terminated by the client, using `.close()`.
+
+### Headers and params
+
 If you want to use Bearer token and/or topics, look at this example (TypeScript):
 
 ```typescript

index.d.ts

@@ -1,4 +1,4 @@
-export type BuiltInEventType = 'open' | 'message' | 'error' | 'close';
+export type BuiltInEventType = 'open' | 'message' | 'error' | 'done' | 'close';
 export type EventType<E extends string = never> = E | BuiltInEventType;
 
 export interface MessageEvent {
@@ -12,6 +12,10 @@ export interface OpenEvent {
   type: 'open';
 }
 
+export interface DoneEvent {
+  type: 'done';
+}
+
 export interface CloseEvent {
   type: 'close';
 }
@@ -55,6 +59,7 @@ export interface EventSourceOptions {
 type BuiltInEventMap = {
   'message': MessageEvent,
   'open': OpenEvent,
+  'done': DoneEvent,
   'close': CloseEvent,
   'error': ErrorEvent | TimeoutEvent | ExceptionEvent,
 };

src/EventSource.js

@@ -18,6 +18,7 @@ class EventSource {
       open: [],
       message: [],
       error: [],
+      done: [],
       close: [],
     };
 
@@ -121,6 +122,7 @@ class EventSource {
           if (xhr.readyState === XMLHttpRequest.DONE) {
             this._logDebug('[EventSource][onreadystatechange][DONE] Operation done.');
             this._pollAgain(this.interval, false);
+            this.dispatch('done', { type: 'done' });
           }
         } else if (xhr.status !== 0) {
           this.status = this.ERROR;