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

@soluzioni-futura/sse-manager

v1.5.2

Published

sse-manager

Downloads

185

Readme

sse-manager

Handle server sent events with ease.

Supported features:

  • handle single request
  • handle multiple requests using rooms abstraction
  • ExpressJs compatible
  • Redis events compatible
  • pluggable with every backend server framework with programmable custom http adapters
  • pluggable with every event dispatcher tool with programmable custom event adapters

Usage

classic usage:

const { createSSEManager } = require("@soluzioni-futura/sse-manager")

const sseManager = await createSSEManager()

app.get("/stream", async(req, res) => {
  const sseStream = await sseManager.createSSEStream(res)
  await sseStream.broadcast({ data: "Joining you to test-room"})
  await sseStream.addToRoom("test-room")
})

setInterval(async() => {
  await sseManager.broadcast("test-room", { data: "Hello test-room people!" })
}, 1000)

with Redis events adapter:

  const redisClient = createClient({
    url: "redis://redis:6379"
  })

  await redisClient.connect()

  const redisSubscriber = redisClient.duplicate()
  await redisSubscriber.connect()

  const sseManager = await createSSEManager({
    eventsAdapter: new RedisEventsAdapter({
      redisClient,
      redisSubscriber
    })
  })

with PostgreSQL events adapter:

  const dbOptions = {
    host: 'your_host',
    user: 'your_user',
    port: 5432,
    password: 'your_password',
    database: 'your_database'
  }

  const sseManager = await createSSEManager({
    eventsAdapter: new PostgresEventAdapter(dbOptions)
  })

createSSEManager options

const sseManager = await createSSEManager({
  httpAdapter: new ExpressHttpAdapter(), // default
  eventsAdapter: new EmitterEventsAdapter() // default, uses node event emitters to broadcast events
})

Adapters

HTTP Adapters

available http adapters:

  • ExpressHttpAdapter: default, uses ExpressJs to handle http requests

  • FastifyHttpAdapter: uses Fastify to handle http requests

  • custom http adapter:

    class CustomHttpAdapter = extends HTTPAdapter {
      constructor() {
        super({
          setResHeaders: (res, headers): void => {
            // add your custom code here
            Object.entries(headers).forEach(([k, v]) => res.set(k, v)) // example: code from ExpressHttpAdapter
          },
    
          writeRes: (res, data): void => {
            // add your custom code here
            res.write(data) // example: code from ExpressHttpAdapter
          },
    
          flushResHeaders: (res): void => {
            // add your custom code here
            res.flushHeaders() // example: code from ExpressHttpAdapter
          },
    
          endRes: (res): void => {
            // add your custom code here
            res.end() // example: code from ExpressHttpAdapter
          },
    
          onCloseCallback: (res, fn): void => {
            // add your custom code here
            res.on("close", fn) // example: code from ExpressHttpAdapter
          }
        })
      }
    }

Event Adapters

available event adapters:

  • EmitterEventsAdapter: default, uses NodeJs event emitters to broadcast events in a single application instance use case
  • RedisEventsAdapter: uses Redis to broadcast events in a multiple application instance use case
  • PostgresEventsAdapter: uses PostgreSQL to broadcast events in a multiple application instance use case
  • custom event adapter:
class CustomEventsAdapter = extends EventsAdapter {
  #emitter = new EventEmitter() // example: code from EmitterEventsAdapter

  constructor() {
    super({
      emit: (event, data) => {
        // add your custom code here

        // example: code from EmitterEventsAdapter
        this.#emitter.emit(event, data)
        return Promise.resolve()
      },
      on: (event, fn) => {
        // add your custom code here

        // example: code from EmitterEventsAdapter
        this.#emitter.on(event, (data) => {
          return fn(data, event)
        })
        return Promise.resolve()
      }
    })
  }
}