❤
npm
Sign UpSign In

sse-nodejs

0.1.0 • Public • Published

Server-Sent-Events-Nodejs

Make Server Sent Events (Node-js)

Easy to make a server sent events(SSE) with nodejs

Install

$ npm install sse-nodejs

How to use

Use with express:

var SSE = require('sse-nodejs');
 
var express = require('express');
 
var app = express();
 
app.get('/', function (req,res) {
   res.sendFile(__dirname+ '/index.html');
});
 
app.get('/time', function (req,res) {
    var app = SSE(res);
 
    app.sendEvent('time', function () {
        return new Date
    },1000);
 
    app.disconnect(function () {
        console.log("disconnected");
    });
 
    app.removeEvent('time',3100);
 
});
 
app.listen(3000, function () {
    console.log('Simple SSE server start at port: 3000')
});
 

Use in frontend

<!DOCTYPE html>
<html>
<head></head>
<body>
HELLO WORLD
<div id="clock"></div>
</body>
<script>
    var ev = new EventSource('/time');
    ev.addEventListener('time', function (result) {
        document.getElementById("clock").innerHTML += '<h4>' + result.data + '</h4>'
    })
</script> 
</html>

Option

    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) <2015> Tran Quoc Cuong

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Readme

Keywords

Package Sidebar

Install

npm i sse-nodejs

Repository

github.com/trquoccuong/Server-Sent-Events-Nodejs

Homepage

github.com/trquoccuong/Server-Sent-Events-Nodejs#readme

Weekly Downloads

24

Version

0.1.0

License

MIT

Last publish

Collaborators

  • trquoccuong
Try on RunKit
Report malware