Code Monkey home page Code Monkey logo

einbahn's Introduction

einbahn

NPM Version Build Status Node.js Version

Server-Sent Events with Namespaces and Channels

  • tested with http1, http2, koa and express
  • namespaces(like namespaces in socket.io or rabbitmq)
  • channels(like rooms in socket.io)
  • automatic keepalive
  • payload is json encoded

getting started

a minimal working example using koa

const Koa = require('koa')
const {SSE, koaMiddleware} = require('einbahn')
const app = new Koa()
const sse = new SSE()
sse.on('connection', client => {
  client.send({event: 'welcome', data: 'message from server'})
})
app.use(koaMiddleware(sse))
app.use((ctx, next) => {
  ctx.body = `<html><meta charset='utf8'/><script>
  let es = new EventSource('/')
  es.addEventListener('welcome', ({ data }) => {
    alert(JSON.parse(data))
  })
</script></html>`
})
app.listen(3000, err => console.log(err ? err : 'listen on http://localhost:3000'))

namespaces

by default all client are connected to the / namespace:

new EventSource('/')

to connect to a specific namespace:

new EventSource('/namespace1')

server side code

const ns1 = sse.of('/namespace1')
// send event to all client within the namespace
ns1.send({event: 'time', data: new Date()})

channels(rooms)

a namespace can have multiple channels, to join client to a channel:

sse.on('connection', (client, lastId, query) => {
  client.join('chan1')
  sse.to('chan1').send({data: new Date()})
})

documentation

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.