tractor-error-handler
v0.2.4
Published
[![Greenkeeper badge](https://badges.greenkeeper.io/phenomnomnominal/tractor-error-handler.svg)](https://greenkeeper.io/) [![npm version](https://img.shields.io/npm/v/tractor-error-handler.svg)](https://www.npmjs.com/package/tractor-error-handler) [![bitH
Downloads
5
Readme
tractor-error-handler
A general HTTP request error handler for tractor.
API:
TractorError
:
Creates a new
TractorError
.
Arguments:
message: string
- the error messagestatus?: number
- the HTTP status of the error
Usage:
let error = new TractorError('something bad happened', 500);
TractorError.isTractorError
:
Checks if something is a
TractorError
.
Arguments:
e: any
- thing to test
Usage:
TractorError.isTractorError(new TractorError('something bad happened')); // true; TractorError.isTractorError(new Error('something bad happened')); // false;
handleError
:
Sends an error back to the client
Arguments:
response:
Response - the Express HTTP response objecterror: TractorError
- the TractorError that was thrown
Usage:
import { TractorError, handleError } from 'tractor-error-handler'; export function myApiEndpoint (request, response) { if (somethingBad) { handleError(response, new TractorError('something bad happened')); } else { response.sendStatus(200); } }