# nodejs-sse
> server sent event
Latest version **1.0.3** (published 2020-11-02) · ISC license · 0 weekly downloads
## Install
```sh
npm install nodejs-sse
pnpm add nodejs-sse
yarn add nodejs-sse
bun add nodejs-sse
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.0.3 |
| Published | 2020-11-02 |
| First published | 2020-11-02 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jaon Micle |
| Maintainers | jaonmicle |
| Keywords | sse |
## Links
- npm: https://www.npmjs.com/package/nodejs-sse
- Repository: https://github.com/JaonMicle/nodejs-sse
- Homepage: https://github.com/JaonMicle/nodejs-sse#readme
- Issues: https://github.com/JaonMicle/nodejs-sse/issues
- npm.io page: https://npm.io/package/nodejs-sse
## Recent versions
- 1.0.3 (latest) — 2020-11-02
- 1.0.2 — 2020-11-02
- 1.0.1 — 2020-11-02
- 1.0.0 — 2020-11-02
## README
# nodejs-sse
## Install
```
$ npm install nodejs-sse
```
## How to use
Use with express:
```javascript
var SSE = require('sse-nodejs');
var express = require('express');
var app = express();
app.get('/', (req,res) => {
res.sendFile(__dirname+ '/index.html');
});
app.get('/time', async(req,res) => {
var app = SSE(res);
app.sendEvent('time', function () {
const data = await getData()
return data
},1000);
app.disconnect( () => {
console.log("disconnected");
});
app.removeEvent('time',3100);
});
app.listen(3000, () => {
console.log('Simple SSE server start at port: 3000')
});
```
Use in frontend
```html
HELLO WORLD
```
## Option
```javascript
var app = sse(res, options);
```
| Option | Desciption |
| ------------- | ------------- |
| padding | add padding 2Kb, default true |
| heartbeat | send a "heartbeat" every 10 seconds. https://bugzilla.mozilla.org/show_bug.cgi?id=444328 |
| retry | time to retry, default time 3000 |
| headers | add extra header, default header {"Content-Type": "text/event-stream","Cache-Control": "no-cache", "Connection": "keep-alive"} |
## Function
| Function | Desciption |
| ------------- | ------------- |
| send(data) | send data only (message on server sent events) |
| sendEvent(name,data,timeInterval) | send data after timeInterval if no timeInterval send once (data can be a function)|
| removeEvent(nameEvent, timeout) | remove an event after timeout, if no timeout it will remove immediately |
| disconnect(function) | listen event 'close' |
## How to use
You can use this module with HTTP response object
### The MIT License (MIT)
Copyright (c) <2020> w3ever
---
_Source: https://npm.io/package/nodejs-sse · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._