nexusse

1.0.1 • Public • Published

As simple Server-Sent Event hub based on Express.

const Nexusse = require('nexusse')
const nexusse = new Nexusse()
 
nexusse.listen();

Installation

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js. Node.js 0.10 or higher is required.

The installation is done using the npm install command:

npm install nexusse

Features

  • ...
  • ...

Documentation

Configuration

The configuration looks like the following:

{
    "port": 3000,
    "keepAliveInterval": 40
}

You can pass a configuration as a literal object to the constructor.

const Nexusse = require('nexusse')
 
const nexusse = new Nexusse({
    port: 3030
})

Port

Default: 3000

The port can be set in the configuration file or passed to the listen() method.

keepAliveInterval

Default: 40 Valid values: 5 and up

You cannot set the keep-alive timer interval to less than 5 seconds.

API

Methods

listen(port, options)

Starts listening on the configured port, or the default port. The first two arguments of this method are directly passed to the Express.js library's listen() method.

port
  • A valid port number (e.g.: 3020): the provided port number will be used.
  • null: The configured port or the default port 3000 will be used.
options

This parameter is directly passed to the Express' listen() method.

get(option)

Read a configuration option.

set(option, value)

Set a configuration option to the specified value.

startKeepAliveTimer()

Start the keep-alive timer. This timer starts automatically when Nexusse starts listening to connections.

You only need to call this method if you had stopped the timer for whatever reason.

Setting a valid keepAliveInterval configuration option will automatically stop then start the keep-alive time.

stopKeepAliveTimer()

Stop the keep-alive timer.

Events

None

Roadmap:

  • Keep the documentation updated
  • Add authentication
  • Server stats HTML endpoints (SSE endpoint, HTML endpoint, REST endpoint)
  • Authentication and access control for publish and subscribers
  • Add proper CORS support
  • Multiple endpoints with their own CORS settings
  • Create a docker image
  • etc.

Package Sidebar

Install

npm i nexusse

Weekly Downloads

34

Version

1.0.1

License

MIT

Unpacked Size

231 kB

Total Files

24

Last publish

Collaborators

  • asiby