README.md

spool-realtime

📦 Realtime Spool. Synchronize the client and server via WebSockets using Primus

Getting Started

Install

npm install --save @fabrix/spool-realtime

Configure

Then edit config/main.ts

export const main = {
  spools: [
    require('@fabrix/spool-router').RouterSpool,
    require('@fabrix/spool-express').ExpressSpool, // Or use a different Webserver Spool such as Hapi, Polka, Koa
    require('@fabrix/spool-realtime').RealtimeSpool
  ]
}

Configure

Create the config file: config/realtime.ts

export const realtime = {
  prefix: null, // The prefix to use for the primus endpoint
  primus:{
    options:{
      //these options are passed directly to the Primus constructor: https://github.com/primus/primus#getting-started
    }
  },
  plugins: {
    // Plugins are a key and a library passed to primus.use
    redis: require('primus-redis-rooms')
  }
}

Client

You can set the config path for the generated primus.js file by either setting

config.main.paths.www (common defaults for webserver spools) or through config.realtime.path which should likely be to a static directory.

You can include the primus client library as a script:

<script src="/<realtime.path>/primus.js"></script>

License

MIT