https://github.com/dbartholomae/middy-middleware-json-error-handler

A middy middleware that returns errors as http errors, compatible with http-errors.
https://github.com/dbartholomae/middy-middleware-json-error-handler

Last synced: 3 days ago
JSON representation

A middy middleware that returns errors as http errors, compatible with http-errors.

• Host: GitHub
• URL: https://github.com/dbartholomae/middy-middleware-json-error-handler
• Owner: dbartholomae
• License: mit
• Created: 2020-01-23T18:33:48.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-12-23T12:56:27.000Z (3 days ago)
• Last Synced: 2024-12-23T13:44:58.836Z (3 days ago)
• Language: TypeScript
• Size: 3.94 MB
• Stars: 30
• Watchers: 3
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# middy-middleware-json-error-handler

[![npm version](https://badge.fury.io/js/middy-middleware-json-error-handler.svg)](https://npmjs.org/package/middy-middleware-json-error-handler)

[![downloads](https://img.shields.io/npm/dw/middy-middleware-json-error-handler.svg)](https://npmjs.org/package/middy-middleware-json-error-handler)

[![open issues](https://img.shields.io/github/issues-raw/dbartholomae/middy-middleware-json-error-handler.svg)](https://github.com/dbartholomae/middy-middleware-json-error-handler/issues)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fdbartholomae%2Fmiddy-middleware-json-error-handler.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fdbartholomae%2Fmiddy-middleware-json-error-handler?ref=badge_shield)

[![debug](https://img.shields.io/badge/debug-blue.svg)](https://github.com/visionmedia/debug#readme)

[![build status](https://github.com/dbartholomae/middy-middleware-json-error-handler/workflows/Build%20and%20deploy/badge.svg?branch=main)](https://github.com/dbartholomae/middy-middleware-json-error-handler/actions?query=workflow%3A"Build+and+deploy")

[![codecov](https://codecov.io/gh/dbartholomae/middy-middleware-json-error-handler/branch/main/graph/badge.svg)](https://codecov.io/gh/dbartholomae/middy-middleware-json-error-handler)

[![semantic release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release#badge)

A [middy](https://github.com/middyjs/middy) middleware that returns errors as http errors, compatible with [http-errors](https://www.npmjs.com/package/http-errors).

## Installation

Download node at [nodejs.org](http://nodejs.org) and install it, if you haven't already.

```sh

npm install middy-middleware-json-error-handler --save

```

## Documentation

There is [additional documentation](https://dbartholomae.github.com/middy-middleware-json-error-handler).

## Usage

```typescript

import middy from '@middy/core'

import JSONErrorHandlerMiddleware from 'middy-middleware-json-error-handler'

import createHttpError from 'http-errors'

import { APIGatewayEvent } from 'aws-lambda'

// This is your AWS handler

async function helloWorld (event: APIGatewayEvent) {

  if (event.queryStringParameters?.search == null) {

    // If you throw an error with status code, the error will be returned as stringified JSON.

    // Only the stack will be omitted.

    throw createHttpError(400, 'Query has to include a search')

  }

  if (event.queryStringParameters?.search === 'error') {

    // If you throw an error with status code greater than 500 and specify in options that the error

    // must be exposed, then the error will be returned as stringified JSON

    throw createHttpError(500, 'Something went wrong', { expose: true })

  }

  // If you throw an error with no status code, only a generic message will be shown to the user

  // instead of the full error

  throw new Error('Search is not implemented yet')

}

// Specify which are the error properties to omit in response (by default, only the stack is omitted)

const options = {

  errorPropertiesToOmit: ['name', 'statusCode', 'stack']

}

// Let's "middyfy" our handler, then we will be able to attach middlewares to it (options parameter is optional)

export const handler = middy(helloWorld)

  .use(JSONErrorHandlerMiddleware(options)) // This middleware is needed do handle the errors thrown by the handler

```