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

request-error-handler

v1.3.2

Published

Standardized error handler for rendering API responses with i18n

Downloads

2,462

Readme

Request Error Handler

NPM version NPM downloads Build status Test coverage Greenkeeper badge

Standardized error handler for rendering API responses with i18n. Automatically renders with support for JSON, XML, HTML and plain text.

Installation

npm install request-error-handler --save

Usage

For the error handler to work, you must emit an error with an array of requestErrors. The format for requestErrors is defined below as an array of RequestErrors.

var errorHandler = require('request-error-handler')
var express = require('express')
var app = module.exports = express()

function responder (req, res, error, stack) { /* Custom respond logic here */ }

var defaultLanguage = 'en'
var customMessages = {}

app.use(errorHandler(responder, defaultLanguage, customMessages))

Options

  • responder Provide a custom error formatter with optional stack depending on environment (default: errorHandler.responder)
  • defaultLanguage Override the default i18n language of English (default: en)
  • customMessages Merge custom i18n messages with default messages (default: {}, see interface below)

The messages interface is as follows:

interface CustomMessages {
  [type: string]: {
    [keyword: string]: {
      [language: string]: (error: RequestError) => string
    }
  }
}

Creating Errors

The only restriction on errors that can be formatted using request-error-handler is that the error instance has an array of error objects on the requestErrors property. Every error object MUST follow the following interface:

interface RequestError {
  type: 'json' | 'form' | 'headers' | 'query' | 'xml' | string /* Comes with standard types built-in, but you can also provide your own */
  keyword: string /* Keyword that failed validation */
  message: string /* Merged with i18n when available */
  id?: string /* A unique identifier for the instance of this error */
  dataPath?: string /* Natural path to the error message (E.g. JSON Pointers when using JSON) */
  data?: any /* The data that failed validation */
  schema?: any /* The schema value that failed validation */
  detail?: string /* Additional details about this specific error instance */
  meta?: { [name: string]: string } /* Meta data from the error (XML validation provides a code, column, etc.) */
}

To automatically create a compatible error instance, use errorHandler.createError and pass an array of errors with an option status number.

License

Apache License 2.0