EventSource
This library is a pure JavaScript implementation of the EventSource client. The API aims to be W3C compatible.
You can use it with Node.js or as a browser polyfill for browsers that don't have native EventSource
support.
Install
Example
Browser Polyfill
Just add example/eventsource-polyfill.js
file to your web page:
Now you will have two global constructors:
If you're using webpack or browserify you can of course build your own. (The example/eventsource-polyfill.js
is built with webpack).
Extensions to the W3C API
Setting HTTP request headers
You can define custom HTTP headers for the initial HTTP request. This can be useful for e.g. sending cookies or to specify an initial Last-Event-ID
value.
HTTP headers are defined by assigning a headers
attribute to the optional eventSourceInitDict
argument:
Allow unauthorized HTTPS requests
By default, https requests that cannot be authorized will cause the connection to fail and an exception to be emitted. You can override this behaviour, along with other https options:
Note that for Node.js < v0.10.x this option has no effect - unauthorized HTTPS requests are always allowed.
HTTP status code on error events
Unauthorized and redirect error status codes (for example 401, 403, 301, 307) are available in the status
property in the error event.
HTTP/HTTPS proxy
You can define a proxy
option for the HTTP request to be used. This is typically useful if you are behind a corporate firewall.
License
MIT-licensed. See LICENSE
Last updated