@sealsystems/failure
v1.2.4
Published
Easy handling of error codes and metadata.
Downloads
5
Keywords
Readme
@sealsystems/failure
Easy handling of error codes and metadata.
Installation
npm install @sealsystems/failure
Quick start
First you need to add a reference to @sealsystems/failure within your application.
const failure = require('@sealsystems/failure');
Then you can create an error object.
const err = failure(42, 'Universal error.', { username: 'hugo' });
This creates an new object of type Error
with some additional properties:
{
name: 'SealError',
code: 42,
message: 'Universal error',
metadata: {
username: 'hugo'
}
...
}
API
Creating an error objects
Create a new object of type Error
.
const error = failure(code, message, metadata);
Parameter:
code number optional error code
message string mandatory error message
metadata object optional error metadata
Result: new error object
Join metadata
Join metadata and error object metadata into a new metadata object for extended logging.
Attention: This function does not alter the errors metadata, it just returns a new metadata object.
const joinedMeta = failure.joinMeta(error, metadata);
Parameter:
error object mandatory previously created error object
metadata object mandatory additional metadata to join
Result: new metadata object
Export plain object
Export a plain new object for return in REST-API.
const plainNewObject = failure.httpExport(error);
Parameter:
error object mandatory previously created error object
Result: new plain javascript object of this structure:
{
code: error.code,
message: error.message,
metadata: error.metadata
}
Export JSON string
Export plain error object as JSON string for return in REST-API without bodyparser.
const stringifiedObject = failure.jsonHttpExport(error);
Parameter:
error object mandatory previously created error object
Result: JSON string of plain object created by httpExport
Test for failure
For testing if an error is a failure you can call isFailure
function.
if (failure.isFailure(error)) { ... }
Parameter:
error object mandatory the error object to test
Assert failure
The assert function throws if the error is NOT(!) a failure.
failure.assert(error);
Parameter:
error object mandatory the error object to test