WebGAP Notifier

README

This is the WebGAP Notifications Management module. Handles abstraction for multiple notification mechanisms.

Dependencies

Handles most common object utilities with underscore.js. Handles async implementation using async.

API

Installation

npm install @webgap/notifier --save

Usage

var notifier = require('@webgap/notifier');

// create Email Notification System Class 
function EmailSystem() {}

// EmailSystem must implement a notify function, doesn't matter how you implement it
EmailSystem.prototype.notify = function (options, callback) {
  console.log('\nEmail system send message: ' + JSON.stringify(options.notification));
  return callback();
};

// register the system
notifier.register({name: 'EMAIL', instance: new EmailSystem(), defaultSystem: true});
...
// register as many systems as you want - notifier.register({name, instance, defaultSystem});
...
// create notification object
var options = {
  notification: {
    userId: 'id of the user to notify',
    message: {
      key: 'messages.error.text',
      data: {errorCode: 111}
    }
  }
};
// notify using the default system
notifier.notify(options, function callback(err) {
  err && console.log(err);
});
...
// notify using specific system(s)
var options = {
  notification: {
    userId: 'id of the user to notify',
    message: {
      key: 'messages.error.text',
      data: {errorCode: 111}
    }
  },
  notificationSystems: [notifier.systems.EMAIL, notifier.systems.OTHER]
};
notifier.notify(options, function callback(err) {
  err && console.log(err);
});
...

Options

Register method accepts the following options:

var options = {
  name: 'name', // the name of the system
  instance: new SomeClass(), // the instance with a notify method
  defaultSystem: true // true or false, defaults to false
};

Notify method accepts the following options:

var options = {
 notification: {}, // an object with the notification that the instance can handle
 notificationSystems: [SystemA, SystemB] // an array with the system you want to notify with, if none is provided the default will be used. If none an error is returned
 };

License

Apache License, Version 2.0