rf-error-handler

handle errors more better.

usage

The best way to use this is to pre setup all your errors when you instantiate the object.

config parameters

name (optional) - set a name for the error (i.e. the script or module)

types (key/value object or array map) - these are shortcuts to trigger error messages.

enter a memorable error name, i.e. INVALID_KEY and enter a message/description

let ErrorHandler = require("rf-error-hander");
let error = new ErrorHandler({
	name: "errorHandler",
	types: {
		BAD_ERROR: "this is a bad error!",
		EXTREMELY_BAD_ERROR: "this is an extremely bad error!"
	};
});

error("BAD_ERROR");

/*

Error [errorHandler]: this is an bad error!
	...
    at node:internal/main/run_main_module:17:47 {
  code: 'ERROR',
  description: undefined
}

*/

error types

The types is flexible, and you can either use an key/value object or an array map.

as key/value object

let error = new ErrorHandler({
	name: "errorHandler",
	types: {
		ERROR_1: "this is an error 1",
		ERROR_2: "this is an error 2"
	};
});

as array map

let error = new ErrorHandler({
	name: "errorHandler",
	types: [
		["ERROR_1", "this is an error 1"]
		["ERROR_2", "this is an error 2"]
	];
});

options

adding a description

error("ERROR", "something went wrong. this is a description");

/*

Error [errorHandler]: this is an error
   	...
    at node:internal/main/run_main_module:17:47 {
  code: 'ERROR',
  description: 'something went wrong. this is a description'
}

*/

adding extra values

error("ERROR", {
	value1: "this is a value",
	value2: "this is another value"
});

/*

Error [errorHandler]: this is an error
    ...
    at node:internal/main/run_main_module:17:47 {
  code: 'ERROR',
  description: undefined,
  value1: 'this is a value',
  value2: 'this is another value'
}

*/