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

rest-api-error-factory

v0.1.2

Published

A factory function to create REST API error classes.

Downloads

4

Readme

rest-api-error-factory

CircleCI Codecov npm npm license

A factory function to create REST API error classes.

Usage

const Koa = require('koa')
const Router = require('koa-router')
const restAPIErrorFactory = require('rest-api-error-factory')

const errors = {
  CLIENT_INVALID_PARAM: {
    message: 'Invalid parameter (%s).',
    httpStatus: 400
  },

  CLIENT_RESOURCE_NOT_FOUND: {
    message: 'Resouce not found.',
    httpStatus: 404
  },

  SERVER_INTERNAL_ERROR: {
    message: 'Server Internal Error (EVENT_ID: %s-%s).',
    httpStatus: 500
  }
}

// create a REST API error class
const RESTError = restAPIErrorFactory(errors)

const app = new Koa()
const router = new Router()

app.use(async(ctx, next) => {
  try {
    await next()
  } catch (e) {
    if (!(e instanceof RESTError)) {
      // here we use raven-logger to log unexpected errors
      // https://github.com/kasha-io/raven-logger
      const { timestamp, eventId } = logger.error(e)
      e = new RESTError('SERVER_INTERNAL_ERROR', timestamp, eventId)
    }

    // here we reply the request with REST API message.
    ctx.status = e.httpStatus
    ctx.body = e.toJSON()
  }
})

router.get('/articles/:id', async ctx => {
  const id = parseInt(ctx.params.id)
  if (isNaN(id)) {
    // throw the error
    throw new RESTError('CLIENT_INVALID_PARAM', 'id', { id: ctx.params.id })
  }

  // ...
})

app.use(router)

app.use(ctx => {
  throw new RESTError('CLIENT_RESOURCE_NOT_FOUND')
})

app.listen(3000)

APIs

restAPIErrorFactory(errorDefs)

Creates an error class that contains error definitions you passed.

errorDefs format:

{
  ERROR_CODE: {
    message: 'MESSAGE'
    httpStatus: STATUS_CODE
  },

  ...
}

Example:

const RESTError = restAPIErrorFactory({
  CLIENT_INVALID_PARAM: {
    message: 'Invalid parameter (%s).',
    httpStatus: 400
  }
})

new RESTError(errorCode, [messageParam1, messageParam2, ...], [extraProperties])

Creates an error instance.

Params:

errorCode: String. The error code you defined in error definition object.
messageParams1, messageParam2, ...: String | Number. The params to format the error message. The message will be formatted by util.format(message, messageParam1, messageParam2, ...). See util.format for details.
extraProperties: Object. Extra properties to set.

Example:

const e = new RESTError('CLIENT_INVALID_PARAM', 'id', { id: 'foo' })

console.log(e.httpStatus)
// -> 400

console.log(e.toJSON())
/*
->
{
  code: 'CLIENT_INVALID_PARAM',
  message: 'Invalid parameter (id).'
  id: 'foo'
}

httpStatus will be excluded
*/

new RESTError(json)

Creates an error instance from JSON object.

Params:

json: JSON object. You can get it from restError.toJSON().

Example:

const e = new RESTError({
  code: 'CLIENT_INVALID_PARAM',
  message: 'Invalid parameter (id).',
  id: 'foo'
})