ng-sb-communication

5.0.1 • Public • Published

SB-Communication

SB-Communication is a base communication low-level library meant to be used in other communication libraries. It allows promise-based communication on both ends, You must write a wrapper for it for your use-case specific stream, socket or resource though. It works in both browsers and node!

Example Communication Implementation

'use babel'
 
import Communication from 'sb-communication'
 
const worker = new WebWorker('worker.js')
 
const communication = new Communication({
  listener(callback) {
    worker.onmessage = callback
  },
  send(data) {
    worker.postMessage = data
  },
})
 
// Event-Specific bindings
communication.on('count-pi', async function(data) {
  // ^ Handlers can return Promises or be sync
  console.log(data)
  return 'Something else'
})

API

export default class Communication {
  constructor({ listener: Function, send: Function })
  on(event, callback)
  send(event, payload)
  dispose()
}

LICENSE

This project is licensed under the terms of MIT License.

Dependencies (0)

    Dev Dependencies (5)

    Package Sidebar

    Install

    npm i ng-sb-communication

    Weekly Downloads

    6

    Version

    5.0.1

    License

    MIT

    Unpacked Size

    10.2 kB

    Total Files

    9

    Last publish

    Collaborators

    • pathikdevani