npm

Does your artifact manager get in the way? Join us on Oct. 8 at 10am PT, to discuss how npm can help.Sign up »

flw-notif

0.0.5 • Public • Published

FLW Notif Library

How to use

npm install flw-notif

var Notif = require('flw-notif');

var notif = new Notif('_APP_TOKEN_');

/*
If you wish to use a diff service url other than the default. Do:

- notif.setSmsUrl('new sms url')
- notif.setEmailUrl('new email url')

Ensure these are set before you call any of the sendEmail / sendSms functions (if you wish to use a diff service url that is)
*/


//To send Email
notif.sendEmail( emailData ).then( function(response) {
    
});
/*
Valid emailData
{
    'template_id':'57f3a06ce9f464d11843a2a2', //Id of the template to use
    'sender_name':'FLW', //Name that appears as sender in recipient's email
    'sender_email':'xyz@mapunza.com', //Email that appears as sender email in recipient's email
    'receiver_email':'dalantorreneo@camuno.com', //Recipient's email
     "placeholders" : {
        "subject" : "EMAIL TEMP",
        "username": "@dalantorreneo"
    }
};
*/


//To send SMS
notif.sendSMS( smsData ).then( function(response) {
    
});

/*
Valid smsData
{
    "template_id" : "57b591bb9400751d114b0583", //Id of the template to use
    "sender" : "PWC", //Name that appears as sender on recipient's phone
    "receiver" : "08140732882", //Phone number of the recipient  
    "placeholders" : { /*  */
        "full_name" : "Dorlet Demide Maek",
        "username": "@dorletGrange"
    }
}
*/




The templating engine used is mustache, hence it is possible to pass placeholders as part of the sent data. They will be used to replace the actual place holders in the template file. As an example consider the following template

Hello {{username}},
Your account on FLW has been created. Please use this token {{usertoken}} to log in.

If

"placeholders" : {
    "username":"DeoleKingsley",
    "usertoken":"FLW-OIE993003"
}

is passed as a value for the placeholders property, {{username}} in the template becomes DeoleKingsley and {{usertoken}} becomes FLW-OIE9933003

install

npm i flw-notif

Downloadsweekly downloads

80

version

0.0.5

license

ISC

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability