3.3 KiB
3.3 KiB
err 
A tiny library to create custom errors in JavaScript.
Installation
$ npm i --save err
Example
// Dependencies
const Err = require("err");
// Basic usage
var e1 = new Err("Some nasty stuff happened");
console.log(e1);
// => [Error: Some nasty stuff happened]
// Provide the error code
var e2 = new Err("Some nasty stuff happened", "NASTY_STUFF_HAPPENED");
console.log(e2);
// => {
// [Error: Some nasty stuff happened]
// code: 'NASTY_STUFF_HAPPENED'
// }
// Provide the error code and some data
var e3 = new Err("Some nasty stuff happened", "NASTY_STUFF_HAPPENED", {
additional: "data"
});
console.log(e3);
// => {
// [Error: Some nasty stuff happened]
// additional: 'data'
// , code: 'NASTY_STUFF_HAPPENED'
// }
// Provide the error data (including the code as well)
var e3 = new Err("Some nasty stuff happened", {
additional: "data"
, code: "NASTY_STUFF_HAPPENED"
});
console.log(e3);
// => {
// [Error: Some nasty stuff happened]
// additional: 'data'
// , code: 'NASTY_STUFF_HAPPENED'
// }
// Wrap an existing error
var existingError = new Error("Some nasty stuff happened");
var e4 = new Err(existingError, {
additional: "data"
, code: "NASTY_STUFF_HAPPENED"
, and: "some more data"
});
console.log(e4);
// => {
// [Error: Some nasty stuff happened]
// additional: 'data'
// , code: 'NASTY_STUFF_HAPPENED'
// , and: 'some more data'
// }
Documentation
Err(error, code, data)
Create a custom error object.
Params
- String|Error
error: The error message or an existingErrorinstance. - String|Object
code: The error code or the data object. - Object
data: The data object (its fields will be appended to theErrorobject).
Return
- Error The custom
Errorinstance.
How to contribute
Have an idea? Found a bug? See how to contribute.
Where is this library used?
If you are using this library in one of your projects, add it in this list. ✨
-
argonby Trevor Burnham -
engine-comp-crud-errorsby jillix -
engine-composition-adapterby jillix