JSPM

  • Created
  • Published
  • Downloads 66
  • Score
    100M100P100Q84671F
  • License MIT

The LoopBack Component that turns this great framework into a powerful real-time platform

Package Exports

  • @mean-expert/loopback-component-realtime

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@mean-expert/loopback-component-realtime) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

LoopBack Component Real-Time

A LoopBack Framework Component that provides publish events over WebSockets.

This module will supersede the [LoopBack Component PubSib] and will implement multiple Real-Time functionalities like PubSub or IO.

This module will also provide the ability to select a transportation driver like socket.io or kafka.

IMPORTANT: This module is currently in alpha version and is not stable for production purposes.

Installation

$ npm install --save @mean-expert/loopback-component-realtime

Setup Module

Update the server/component-config.json as follows:

{
  "loopback-component-explorer": {
    "mountPath": "/explorer"
  },
  "@mean-expert/loopback-component-realtime": {
    "debug": true,
    "driver": {
      "name": "socket.io-client | kafka"
    },
    "modules": [
      "IO",
      "PubSub"
    ]
  }
}

Update the server/model-config.json as follows:

{
    "mixins": [
        "loopback/common/mixins",
        "loopback/server/mixins",
        "../common/mixins",
        "./mixins",
        "../node_modules/loopback-component-realtime/dist/mixins"
    ]
}
``