0.0.3 • Published 8 years ago
js-errors v0.0.3
js-errors
General javascript errors generator
javascript errors with
1. Domain
The same as prefix, errors with prefix can be more recognizable
2. Predefined errors
Predefined errors are standard errors of js-errors and will be enriched
3. I18n
Error messages vary with locales
4. Customization
Error folder can be specified to customize errors
5. Unification
Error code of each error can never be changed, so it can be exchangable through projects, no need to define errors for every project
Installation
$ npm install --save js-errors
Usage
//Error generation
var BaseError = require('js-errors').error;
//Error definition
var i18n = require('js-errors').i18n;
var errorMessages = i18n.get(pathOfErrorMessagesDefined);
New An Error
var error = new BaseError({
errors: ['user', 'not', 'found'], //Sequential Error Description
prefix: 'java:', //Prefix for Messages
code: 404, //Numeric value for this error
message: 'User is not found!', //Customized Error Messsage
locale: 'en-US', //Locale for errors
i18n: i18n.get(dir) //Customized error definition directory
});
//error.name => "UserNotFound"
//error.code => 404
//error.message => "java:User is not found!"
//error.restify() => { code: 404, message: "js:hello", name: 'UserNotFound'}
Throw An Error
throw error;
Error Messages
- js-errors predefined some errors as standard errors
- errors can be customized by folders or by generation
- can also be replaced by providing locales folder when creating a generator
License
MIT © calidion