🌜
🌞
@middy/http-header-normalizer

@middy/http-header-normalizer

v3.1.1

Http header normalizer middleware for the middy framework

npm install @middy/http-header-normalizer

README

Middy http-header-normalizer middleware

Middy logo

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

npm version npm install size GitHub Actions CI status badge
Standard Code Style Known Vulnerabilities Language grade: JavaScript Core Infrastructure Initiative (CII) Best Practices
Chat on Gitter Ask questions on StackOverflow

You can read the documentation at: https://middy.js.org/docs/middlewares/http-header-normalizer

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): a function that accepts an header name as a parameter and returns its canonical representation.
  • canonical (boolean) (default false): if true, modifies the headers to canonical format, otherwise the headers are normalized to lowercase

Sample usage

import middy from '@middy/core'
import httpHeaderNormalizer from '@middy/http-header-normalizer'

const handler = middy((event, context) => {
  return {}
})

handler
  .use(httpHeaderNormalizer({canonical: true}))

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-2022 Luciano Mammino, will Farrell, and the Middy team.

FOSSA Status

Release Notes

3.1.1
By will Farrell • Published on August 4, 2022

What's Changed

  • Add in module to package.json files @willfarrell
  • performance improvements @willfarrell

TypeScript

Docs

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.1.0...3.1.1

3.1.0
By will Farrell • Published on June 21, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.0.4...3.1.0

3.0.4
By will Farrell • Published on June 4, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.0.3...3.0.4

3.0.3
By will Farrell • Published on May 17, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.0.2...3.0.3

3.0.2
By will Farrell • Published on May 13, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.0.1...3.0.2

3.0.1
By will Farrell • Published on May 13, 2022

What's Changed

  • Updated dependencies

Full Changelog: https://github.com/middyjs/middy/compare/3.0.0...3.0.1

General

License
MIT
Typescript Types
Built-in
Tree-shakeable
Yes

Popularity

GitHub Stargazers
3,045
Community Interest
2,905
Number of Forks
294

Maintenance

Commits
11/2110/220250
Last Commit
Open Issues
5
Closed Issues
416
Open Pull Requests
2
Closed Pull Requests
149

Versions

Versions Released
11/2110/22010
Latest Version Released
Aug 4, 2022
Current Tags
latest3.1.1
next3.1.0-rc.1

Dependencies

Dependencies (0)
Dev Dependencies (1)

Contributors

willfarrell
willfarrell
Commits: 384
lmammino
lmammino
Commits: 113
vladgolubev
vladgolubev
Commits: 12
thejuan
thejuan
Commits: 12
greenkeeper[bot]
greenkeeper[bot]
Commits: 12
dkatavic
dkatavic
Commits: 11
gsingh1
gsingh1
Commits: 10
joseSantacruz
joseSantacruz
Commits: 9
theburningmonk
theburningmonk
Commits: 6
leog
leog
Commits: 6
ossareh
ossareh
Commits: 5
JimiPedros
JimiPedros
Commits: 4
sdomagala
sdomagala
Commits: 4
munierujp
munierujp
Commits: 4
denovodavid
denovodavid
Commits: 3