npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@dachendev/express-sse

v1.0.0

Published

Easy Server-Sent Events for Express.js

Downloads

19

Readme

express-sse

Easy Server-Sent Events for Express.js

What's this?

express-sse is a neat little package that makes working with Server-Sent Events (SSE) in Express.js a breeze. It gives you a simple pub/sub system for real-time, one-way communication from your server to clients. No more headaches setting up SSE endpoints or managing subscriptions!

Getting Started

First, grab the package:

npm install @dachendev/express-sse

How to Use

Quick Start

Here's the simplest way to get going:

const express = require('express')
const { expressSSE } = require('express-sse')

const app = express()
const { router, broker } = expressSSE(app)

router.sse('/events', (sse, req, res) => {
  sse.send('Hello, SSE!')
  sse.send({ message: 'I can send JSON too!', time: new Date() })
})

Real-world Scenario

Let's say you want to push updates to your clients:

const express = require('express')
const { expressSSE } = require('express-sse')

const app = express()
const { router, broker } = expressSSE(express.Router())

router.sse('/events', (sse, req, res) => {
  sse.comment('Waiting for updates...')
  sse.subscribe('updates', (data) => sse.send(data))
})

app.post('/update', (req, res) => {
  broker.publish('updates', { type: 'update', data: req.body })
  res.json({ success: true })
})

app.use(router)

Advanced Usage

Need more control? You can use the middlewares separately:

const express = require('express')
const { sseMiddleware, sseBrokerMiddleware, Broker } = require('express-sse')

const app = express()
const broker = new Broker()

app.get('/sse-only', sseMiddleware(), (req, res) => {
  req.sse.send('Using just the SSE middleware')
})

app.get(
  '/sse-with-broker',
  sseMiddleware(),
  sseBrokerMiddleware(broker),
  (req, res) => {
    req.sse.comment('Using both middlewares')
    req.sse.subscribe('updates', (data) => req.sse.send(data))
  }
)

app.post('/publish', (req, res) => {
  broker.publish('updates', req.body)
  res.json({ success: true })
})

API Quick Reference

  • expressSSE(router, options): Sets up your router with SSE superpowers.
  • router.sse(path, ...middlewares, handler): Creates an SSE endpoint.
  • sse.send(data): Sends data (string or object) to the client.
  • sse.comment(text): Sends a comment to the client (useful for keeping connections alive).
  • sse.subscribe(topic, callback): Listens for updates on a topic.
  • sse.unsubscribe(topic, id): Stops listening to a topic.
  • sse.unsubscribeAll(): Unsubscribes from everything.
  • broker.publish(topic, data): Broadcasts data to all subscribers of a topic.

That's it! Now go build some awesome real-time features with express-sse. If you run into any issues or have questions, feel free to open an issue on GitHub. Happy coding!