Make sure the open source you're using is safe to use
eventsource
v1.0.7W3C compliant EventSource client for Node.js and browser (polyfill)
npm install eventsource
Explore Similar Packages
Package Health Score
64 / 100
- Popularity Influential project
- Maintenance Inactive
- Security No known security issues
- Community Sustainable
Make sure the open source you're using is safe to usePopularity
Influential project
Weekly Downloads (8,222,392)- Dependents
- 571
- GitHub Stars
- 532
- Forks
- 154
- Contributors
- 40
The npm package eventsource receives a total of 8,222,392 downloads a week. As such, we scored eventsource popularity level to be Influential project.
Based on project statistics from the GitHub repository for the npm package eventsource, we found that it has been starred 532 times, and that 571 other projects in the ecosystem are dependent on it.
Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.
Security
No known security issues
Security and license risk for significant versions
All VersionsDirect Vulnerabilities
0.0.10
0.1.6
0.2.3
1.0.7
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
Indirect Vulnerabilities
0.0.10
0.1.6
0.2.3
1.0.7
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
License Risks
0.0.10
0.1.6
0.2.3
1.0.7
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
All security vulnerabilities belong to
production dependencies of direct and indirect
packages.
We found a way for you to contribute to the project! Looks like eventsource is missing a security policy.
You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.
We found a way for you to contribute to the project! Looks like eventsource is missing a security policy.
# Install the Snyk CLI and test your project
npm i snyk && snyk test eventsource
Maintenance
Inactive
Commit Frequency- Open Issues
- 21
- Merged PR
- 48
- Open PR
- 3
- Last Commit
- 7 months ago
Further analysis of the maintenance status of eventsource based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.
An important project maintenance signal to consider for eventsource is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.
In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.
Community
Sustainable
- Readme.md
- Yes
- Contributing.md
- Yes
- Code of Conduct
- No
- Contributors
- 40
- Funding
- No
With more than 10 contributors for the eventsource repository, this is possibly a sign for a growing and inviting community.
We found a way for you to contribute to the project! Looks like eventsource is missing a Code of Conduct.
Embed Package Health Score Badge
Package
- Node.js Compatibility
- >=0.12.0
- Age
- 9 years
- Dependencies
- 1 Direct
- Versions
- 30
- Install Size
- 445 kB
- Dist-tags
- 1
- # of Files
- 14
- Maintainers
- 2
- TS Typings
- Yes
eventsource has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.
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
npm install eventsource
Example
npm install
node ./example/sse-server.js
node ./example/sse-client.js # Node.js client
open https://localhost:8080 # Browser client - both native and polyfill
curl https://localhost:8080/sse # Enjoy the simplicity of SSE
Browser Polyfill
Just add example/eventsource-polyfill.js file to your web page:
<script src=/eventsource-polyfill.js></script>
Now you will have two global constructors:
window.EventSourcePolyfill
window.EventSource // Unchanged if browser has defined it. Otherwise, same as window.EventSourcePolyfill
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:
var eventSourceInitDict = {headers: {'Cookie': 'test=test'}};
var es = new EventSource(url, eventSourceInitDict);
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:
var eventSourceInitDict = {https: {rejectUnauthorized: false}};
var es = new EventSource(url, eventSourceInitDict);
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.
es.onerror = function (err) {
if (err) {
if (err.status === 401 || err.status === 403) {
console.log('not authorized');
}
}
};
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.
var es = new EventSource(url, {proxy: 'https://your.proxy.com'});
License
MIT-licensed. See LICENSE
eventsource versions
| Version | Published | Tag | Node.js Compatability | Licenses | Dependencies | Direct Vulnerabilities | Publisher |
|---|---|---|---|---|---|---|---|
| 1.0.7 | 27 August 2018 | latest | >=0.12.0 | MIT | 1 |
| rexxars |
| 0.2.3 | 17 April 2017 | >=0.8.0 | MIT | 1 |
| rexxars | |
| 0.1.6 | 09 February 2015 | >=0.8.0 | MIT | 1 |
| aslakhellesoy | |
| All Versions | |||||||
eventsource dependencies
Last updated on
24 January-2021, at 17:18 (UTC).