Naive Puppets Marching

    middy-middleware-json-error-handler
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.0 • Public • Published

    middy-middleware-json-error-handler

    npm version downloads open issues FOSSA Status debug build status codecov dependency status devDependency status semantic release Gitter

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

    Installation

    Download node at nodejs.org and install it, if you haven't already.

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

    Documentation

    There is additional documentation.

    Usage

    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 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')
    }
    
    // Let's "middyfy" our handler, then we will be able to attach middlewares to it
    export const handler = middy(helloWorld)
      .use(JSONErrorHandlerMiddleware()) // This middleware is needed do handle the errors thrown by the JWTAuthMiddleware

    Install

    npm i middy-middleware-json-error-handler

    DownloadsWeekly Downloads

    949

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    14.9 kB

    Total Files

    15

    Last publish

    Collaborators

    • dbartholomae