npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

custom-error-exceptions

v1.2.4

Published

Custom error exceptions for microservices

Downloads

40

Readme

Custom Error Exceptions

Test Status Version Status Issues Status

Custom error exceptions are made to make it easier to handling errors. You can also make custom errors as needed.

Installation

$ npm install custom-error-exceptions

Usage

Using Template Error (BAD_REQUEST)

const express = require('express');
const {
  handlers: { errorHandler },
  errors: { BadRequestError }
} = require('custom-error-exceptions');

const app = express();
const port = 3044;
app.use(express.json());

//TEMPLATE BAD REQUEST ERROR 
app.post('/', (req, res) => {
  const name = req.body.name;
  if (typeof name !== 'string') {
    throw new BadRequestError();
  }
  res.send(
    req.body
  );
});

//Error Handler
app.use(errorHandler);
app.listen(port, () => console.log(`app listen on port ${port}`));

Using Template Error (BAD_REQUEST) With Custom Message

//TEMPLATE BAD REQUEST ERROR WITH CUSTOM MESSAGE
app.post('/custom-message', (req, res) => {
  const name = req.body.name;
  if (typeof name !== 'string') {
    throw new BadRequestError('Name type must be string');
  }
  res.send(req.body);
});

Using Custom Error

const {
  handlers: { errorHandler },
  errors: { CustomError }
} = require('custom-error-exceptions');

//CUSTOM ERROR
app.post('/custom-error', (req, res) => {
  const name = req.body.name;
  if (typeof name !== 'string') {
    throw new CustomError('Custom Message', 'CUSTOM_CODE', 700);
  }
  res.send(req.body);
});

Handling NOT_FOUND Route

const {
  handlers: { errorHandler, notFoundHandler },
} = require('custom-error-exceptions');

------------------------------------
             YOUR ROUTE
------------------------------------

app.use(notFoundHandler);
app.use(errorHandler);

How to handle UnhandledRejection for Async Function in Express

const {
  handlers: { createHandler }
} = require('custom-error-exceptions');

const getName = async (req, res) => {
  /*some asynchronous logic here
    example :
    const nameFromDb = await getDataFromDb(req.body.id);
  */
  const id = req.body.id;
  res.send({
    id,
    nameFromDb: 'John Doe'
  })
}

//Implementing in Router
app.post(
  '/unhandled-rejection', 
  createHandler(getName)
);

To further explore you can see an example this repo.

LIST OF ERROR TEMPLATES

  • CustomError
  • BadRequestError
  • UnauthorizedError
  • PaymentRequiredError
  • ForbiddenError
  • NotFoundError
  • MethodNotAllowedError
  • NotAcceptableError
  • ProxyAuthenticationError
  • RequestTimeoutError
  • ConflictError
  • GoneError
  • LengthRequiredError
  • PreconditionFailedError
  • PayloadTooLargeError
  • UriTooLongError
  • UnsupportedMediaTypeError
  • RangeNotSatisfiableError
  • MisdirectedRequestError
  • UnprocessableEntityError
  • LockedError
  • FailedDependencyError
  • TooEarlyError
  • UpgradeRequiredError
  • PreconditionRequiredError
  • TooManyRequestsError
  • RequestHeaderError
  • LegalReasonsError
  • InternalServerError
  • NotImplementedError
  • BadGatewayError
  • ServiceUnavailableError
  • GatewayTimeoutError
  • HttpNotSupportedError
  • VariantAlsoNegotiatesError
  • InsufficientStorageError
  • LoopDetectedError
  • NotExtendedError
  • NetworkAuthenticationRequiredError

The list above is based on the client error list and server error list as on this page.

Version History

  • version 1.0.0
    • Basic Template Errors
    • Basic Custom Error
    • Error Handler
    • Not Found Route Handler for Express
  • version 1.1.0
    • Create middleware function to handling 'UnhandledRejection' for asynchronous route in Express
  • version 1.2.0
    • Adding logging middleware in every request with winston
  • version 1.2.1
    • Adding and showing error logger to console if request error
  • version 1.2.2
    • Adding handler with view engine (createWebHandler)
  • version 1.2.3
    • Handling response message when handler get Unhandled Exceptions error message from asynchronous router
  • version 1.2.4
    • Minor security update for Mocha and Nodemon

Contributor