JavaScript/TypeScript errors with optional details and a code
npm install error-deets
An extension of vanilla JS errors, that adds two fields:
- code
- details
There are a few good reasons to add these fields to a standard error object.
1. Resuable error objects were few and far in-between in the author's experience with build complex nodejs projects.
2. custom errors, that extend the base error object, while a nobel thought, are too much work for a single use error objects. When absolutely needed, the .code property, set to a unique value suffices.
3. In most cases of error, passing an error message with some details from the execution context suffices to provide debuggable hints. Further, using logging solutions like winston, it's easy to log these to any log collector. log.error(err.message, err.details);
Ooh, and this is developed in TypeScript, because it rocks!
npm install error-deets
Throwing an error
``typescript
import { ErrorDeets as Error } from 'error-deets';
throw new Error(a unique error message, {
details: {
some: 'object with details'
},
code: 'StringOrNumOrTypeScriptEnum'
});
`
Catching and logging an error
`TypeScript
try {
someFunThatThrow();
} catch (err) {
log.error(err.message, err.details);
}
``