ErrorMapper

ErrorMapper it's a tool to Create, Produce, trace and log errors.

Features

• Define yours errors
• Create multiple categories
• Find a Error by CODE and NAME
• Multi Level of your Error (default info,warning,critical) or define yours
• Auto produce a throw Error

Installation

Install using npm:

$ npm install custom-error-mapper

Defining error messages

The examples assume you've required the errors module like so:

const { ErrorInfo, CustomErrorMapper }= require('error-mapper');
const errors = new CustomErrorMapper()

Create a error

errors.create("wheel",[
    new ErrorInfo({
        name: "LOW_PRESSURE",
        message:"low pressure on tire",
        code:100,   //each category has separate code list, for this reason can repeat code 100
        level:"info",
        solution:"inflate tires",
        throwable: false
    }),
])
console.log(errors.wheel.find("LOW_PRESSURE")) //all Error data

By List

const engineErrors = [
    new ErrorInfo({
        name: "FUEL_CAP",
        message:"Faulty Fuel cap",
        code:100,
        level:"warning",
        solution: "Tighten or replace", //util when you get a error print the solution to user(frontEnd,alerts,etc)
        throwable: false //if not defined: false
    }),
    new ErrorInfo({
        name: "OXYGEN_SENSOR",
        message:"Bad oxygen sensor",
        //code:101, //will auto generate code 5000
        level:"critical",
        solution:"Replace oxygen sensor",
        throwable: true //if this error occurs will auto create a throw error.
        //A good solution for auto break your program/function(using try-catch recommended) and get error.
        //Reduce use if(fail) on every return function
    }),
    new ErrorInfo({
        name: "IGNITION_COIL",
        message:"Faulty Ignition coil and bad spark plugs",
        code:101,
        //level:"critically", //if not defined will be "warning"
        solution:"Change ignition coils and the bad spark plugs",
        throwable: false
    }),
]
//add a category and pass a list of errors
errors.create("engine",engineErrors)

Get a Error info

console.log(errors.wheel.find("LOW_PRESSURE")) //all Error data

or

console.log(errors.wheel.find(100)) //FUEL_CAP Error.

or

console.log(errors.["wheel"].find(100)) //FUEL_CAP Error.

Produce a Error

throw errors["wheel"].find("LOW_PRESSURE")

or

throw errors.wheel.find("LOW_PRESSURE")

or

throw errors.wheel.find(100)

Error structure

from:

const error1 = errors.wheel.find("LOW_PRESSURE")

• getCode() return code. Ex: 100
• getName() return name. Ex: "LOW_PRESSURE"
• getLevel() return level. Ex: "info"
• getClass() return all structure.

Classify your errors

from:

try {
    const error1 = errors.engine.find(101) //IGNITION_COIL Error.
    throw error1 //generate Error and exit from try
} catch (error) {
    if(error instanceof CustomErrorMapper){ //true //capture all errors generates from CustomErrorMapper
        console.log( "CustomErrorMapper Error produced" )
        if(error.level == errors.level.fatal)
            console.log( "a fatal produced" )
        if(error.category == errors.category.wheel)
            console.log( "error on wheel system" )
    }else{
        console.log(error) //other error
    }
}

License

The MIT License (MIT) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.