err-loggr v1.2.0

err-loggr

This script requires Node.js

You can find more about node.js here: https://nodejs.org/

Description

This library will be help manage the creatition and writing of log files.

Requirements

• Git
• Node.js
• npm or yarn

Setup

• This library is available on npm

npm install err-loggr s 
// or
yarn add err-loggr

Website

• https://www.npmjs.com/package/err-loggr

General Case

/**
* creats a dir called log 
* creates a log file LOG FILE - (mm/dd/yy)
*/
const Loggr = require('err-loggr');
const loggr = new Loggr();

loggr.error('TEST ERROR MESSAGE',8);
//writes to file
/**
* ERROR - 03:24PM
* OCCURED ON LINE: 8
* TEST ERROR MESSAGE
*/


loggr.message('TEST MESSAGE',9)
//writes to file
/**
* MESSAGE - 03:24PM
* OCCURED ON LINE: 9
* TEST MESSAGE
*/

Name your file

/**
* create a dir with desired name
* create a log file with desired name and tags with mm/dd/yy (desiredLogFileName - mm/dd/yy)
*/

const Loggr = require('err-loggr');
const loggr = new Loggr('fileName','path/to/dir');

/**
 * path
 * |____to
 *      |____dir
 *           |____fileName     
 */

Email Options

let mailOptions = {
    to: 'name@example.com',              //required
    from:'yourname@example.com',         //default to err@loggr.com
    cc:'someone@example.com',            //default null
    bcc:'someoneelse@example.com',       //default null
    subject:'Test send file'             //default LOG - base dirname
    maxAttempts:5                        //default 3 attempts to send email if failure occurs
}

/**
* This sends an email of your file with the mail options above.
* 
* Use if (loggr.error.length){} call if you only want an email sent in case of errors
* If you want the receive an email no matter what, you can just use the loggr.email() call
* 
*/
if(loggr.errors.length >0){
    loggr.email(mailOptions)
}
;

Change Log

- 11/26/2018 - Added email function
- 1/11/2018 - Update email function