Have ideas to improve npm?Join in the discussion! »

    @middy/http-header-normalizer
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.1 • Public • Published

    Middy http-header-normalizer middleware

    Middy logo

    HTTP header normalizer middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda

    This middleware normalizes HTTP header names to their canonical format. Very useful if clients are not using the canonical names of header (e.g. content-type as opposed to Content-Type).

    API Gateway does not perform any normalization, so the headers are propagated to Lambda exactly as they were sent by the client.

    Other middlewares like jsonBodyParser or urlEncodeBodyParser will rely on headers to be in the canonical format, so if you want to support non-normalized headers in your app you have to use this middleware before those ones.

    This middleware will copy the original headers in event.rawHeaders.

    Install

    To install this middleware you can use NPM:

    npm install --save @middy/http-header-normalizer

    Options

    • normalizeHeaderKey (function) (optional): a function that accepts an header name as a parameter and returns its canonical representation.
    • canonical (bool) (optional): if true, modifies the headers to canonical format, otherwise the headers are normalized to lowercase (default false)

    Sample usage

    import middy from '@middy/core'
    import httpHeaderNormalizer from '@middy/http-header-normalizer'
    
    const handler = middy((event, context) => {
      return {}
    })
    
    handler
      .use(httpHeaderNormalizer())

    Middy documentation and examples

    For more documentation and examples, refers to the main Middy monorepo on GitHub or Middy official website.

    Contributing

    Everyone is very welcome to contribute to this repository. Feel free to raise issues or to submit Pull Requests.

    License

    Licensed under MIT License. Copyright (c) 2017-2021 Luciano Mammino, will Farrell, and the Middy team.

    FOSSA Status

    Install

    npm i @middy/http-header-normalizer

    DownloadsWeekly Downloads

    17,769

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    8.01 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar