Miss any of our Open RFC calls?Watch the recordings here! »

@small-tech/sendevent

1.0.1 • Public • Published

sendevent


Note: this is a fork.

This fork of sendevent. You should use the main project once the following pull requests have been merged:

Awaiting merge

  • Fix disconnection issue on Firefox after 30 seconds of inactivity following a page reload. (Pull request)

I’m publishing this fork for our own internal use at Small Technology Foundation in Site.js and you are, of course, more than welcome to use it in your projects but please keep an eye on Felix Gnass’s original repository and use the module from there once the above pull requests have been merged.

Thank you, Felix, for this and for instant (which sendevent is used in) for making my life easier and Site.js better :)

References on the Firefox issue

Original readme follows:


Middleware to stream server-sent events to the client. Browsers that don't support the EventSource interface will fall back to a hidden iframe.

Server

Here is a simple express app that broadcasts a timestamp every 10 seconds.

var express = require('express');
var sendevent = require('sendevent');
var app = express();
 
// create a middlware that handles requests to `/eventstream`
var events = sendevent('/eventstream');
 
app.use(events);
 
// serve an empty page that just loads the browserify bundle
app.get('/', function(req, res) {
  res.end('<script src="/bundle.js"></script>');
});
 
// broadcast data to all connected clients every 10 seconds
setInterval(function() {
  events.broadcast({ time: Date.now() });
}, 10000);

Advanced Usage

// if needed you can also talk to individual clients
events.on('connect', function(client) {
  client.send({ greeting: 'hello number ' + client.id });
});
 
// and get notified when they disconnect
events.on('disconnect', function(client) {
  console.log('client %d disconnected', client.id);
});

Client

If you use browserify you can simply require sendevent module:

var on = require('sendevent');
on('/eventstream', function(ev) {
  console.log(ev);
});

The MIT License (MIT)

Copyright (c) 2013 Felix Gnass

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.

Install

npm i @small-tech/sendevent

DownloadsWeekly Downloads

1

Version

1.0.1

License

MIT

Unpacked Size

18.5 kB

Total Files

14

Last publish

Collaborators

  • avatar