🚦Provide Exceptions for REST API based on Express.js. Written in Typescript !
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
sh
src
test
.gitignore
.npmignore
.nycrc
.travis.yml
CONTRIBUTING.md
LICENSE
package.json
readme.md
tsconfig.compile.json
tsconfig.json
tslint.json
yarn.lock

readme.md

ts-httpexceptions

Build Status Coverage Status TypeScript Package Quality npm version Dependencies img img Known Vulnerabilities semantic-release

Provide Exceptions for REST API based on Express.js. Written in Typescript !

See guide installation and our API.

Features

Some HTTP Exceptions are already implemented :

Redirections (3xx):

  • MovedPermanently,
  • MovedTemporarily,
  • MultipleChoices,
  • NotModified,
  • PermanentRedirect,
  • SeeOther,
  • TemporaryRedirect,
  • TooManyRedirects,
  • UseProxy.

Client errors (4xx) :

  • BadMapping,
  • BadRequest,
  • Conflict,
  • ExpectationFailed,
  • Forbidden,
  • Gone,
  • ImATeapot,
  • LengthRequired,
  • MethodNotAllowed,
  • MisdirectedRequest,
  • NotAcceptable,
  • NotFound,
  • PaymentRequired,
  • PreconditionFailed,
  • PreconditionRequired,
  • ProxyAuthentificationRequired,
  • RequestedRandeUnsatifiable,
  • RequestTimeout,
  • RequestURITooLong,
  • TooManyRequests,
  • Unauthorized,
  • UnavailabledForLegalReasons,
  • UnsupportedMediaType,
  • UpgradeRequired.

Server errors (5xx) :

  • BadGateway,
  • BandwidthLimitExceeded,
  • GatewayTimeout,
  • InternalServerError,
  • NetworkAuthenticationRequired,
  • NotExtended,
  • NotImplemented,
  • ProxyError,
  • ServiceUnvailable,
  • VariantAlsoNegotiates.

You can use HTTPExceptions method to throw a custom Exception.

Installation

$ npm install -g typescript@2.0.2
$ npm install ts-httpexceptions

API

   import {BadRequest, Exception} from 'ts-httpexceptions';
   let express = require('express');
   let app = express();
   
   app.get('/my/route', (req, res) => {
   
        throw new BadRequest('Custom Message'); //Emit
        // OR
        // throw new Exception(510, 'Custom Message');
   
   });
   
   app.get('/my/route/params', (req, res) => {
      
      if (req.params.id === undefined){
        throw new BadRequest();
      }
      
   });
   
   
   //GlobalHandler middleware catch exception and send response to the client
   app.use((err, request, response) => {

        if(err instanceof Exception){
            response.status(err.status).send(err.message);
        }

   });

Test

$ npm install -g mocha
$ npm test

License

The MIT License (MIT)

Copyright (c) 2016 Romain Lenzotti

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.