https://github.com/asiby/nexusse
A Node JS Pub/Sub HUB for Server Sent Event
https://github.com/asiby/nexusse
eventsource hub sse
Last synced: 5 months ago
JSON representation
A Node JS Pub/Sub HUB for Server Sent Event
- Host: GitHub
- URL: https://github.com/asiby/nexusse
- Owner: asiby
- License: mit
- Created: 2020-04-19T05:50:42.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-06-11T16:00:07.000Z (about 1 year ago)
- Last Synced: 2025-08-25T07:21:47.136Z (10 months ago)
- Topics: eventsource, hub, sse
- Language: JavaScript
- Homepage:
- Size: 174 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
As simple Server-Sent Event hub based on Express.
```js
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:
```js
{
"port": 3000,
"keepAliveInterval": 40
}
```
You can pass a configuration as a literal object to the constructor.
```js
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](https://expressjs.com/en/4x/api.html#app.listen).
##### 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.