leverage-plugin-socket.io

WebSockets for Leverage!

This plugin supports the websocket component and middleware types.

Config

{
    event: 'event-name',
    namespace: '/my-namespace' // optional
}

Example

import { Component } from 'leverage-js'
 
class MyComponent extends Component {
  constructor () {
    super()
 
    this.config = {
      type: 'websocket',
      websocket: {
        /*
         * Specify an event
         */
        event: 'ping',
 
        /*
         * Optionally specify a namespace
         */
        namespace: '/my-namespace'
      }
    }
  }
 
  /*
   * Then the callback for our type. This is supplied with
   *  the `data` and `socket` for this request, and the
   *  global `io` instance.
   */
  websocket (socket, io, ...data) {
    socket.emit('pong')
  }
}

Then just make sure to add the plugin to Leverage's manager along with your component instance! Here, we'll also use the http middleware to start the server listening.

import http from 'leverage-plugin-http'
import websocket from 'leverage-plugin-socket.io'
import { manager } from 'leverage-js'
 
/* ... all the code from the previous example ... */
 
manager.plugin(http)
manager.plugin(websocket)
 
manager.add(new MyComponent) 
 
/*
 * Don't forget to listen on a port!
 */
http.listen(3000)