🌜
🌞
@middy/http-multipart-body-parser

@middy/http-multipart-body-parser

v3.1.1

Http event normalizer middleware for the middy framework

npm install @middy/http-multipart-body-parser

README

Middy http-multipart-body-parser middleware

Middy logo

HTTP json body parser 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-multipart-body-parser

Automatically parses HTTP requests with content type multipart/form-data and converts the body into an object. Also handles gracefully broken JSON as UnprocessableEntity (422 errors) if used in combination with httpErrorHandler.

It can also be used in combination with validator so that the content can be validated.

Note: by default this is going to parse only events that contain the header Content-Type (or content-type) set to multipart/form-data. If you want to support different casing for the header name (e.g. Content-type) then you should use the httpHeaderNormalizer middleware before this middleware.

Install

To install this middleware you can use NPM:

npm install --save @middy/http-multipart-body-parser

Options

  • busboy (object) (default {}): it can be used to pass extraparameters to the internal busboy instance at creation time. Checkout the official documentation for more information on the supported options.

Note: this middleware will buffer all the data as it is processed internally by busboy, so, if you are using this approach to parse significantly big volumes of data, keep in mind that all the data will be allocated in memory. This is somewhat inevitable with Lambdas (as the data is already encoded into the JSON in memory as Base64), but it's good to keep this in mind and evaluate the impact on you application.
If you really have to deal with big files, then you might also want to consider to allowing your users to directly upload files to S3

Sample usage

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

// invokes the handler
const event = {
  headers: {
    'Content-Type': 'multipart/form-data; boundary=----WebKitFormBoundaryppsQEwf2BVJeCe0M'
  },
  body: 'LS0tLS0tV2ViS2l0Rm9ybUJvdW5kYXJ5cHBzUUV3ZjJCVkplQ2UwTQ0KQ29udGVudC1EaXNwb3NpdGlvbjogZm9ybS1kYXRhOyBuYW1lPSJmb28iDQoNCmJhcg0KLS0tLS0tV2ViS2l0Rm9ybUJvdW5kYXJ5cHBzUUV3ZjJCVkplQ2UwTS0t',
  isBase64Encoded: true
}
handler(event, {}, (_, body) => {
  t.is(body,{ foo: 'bar' })
})

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

2.5.7
By will Farrell • Published on January 25, 2022

Fix publishing transpiling error in 2.5.6. Thanks to @maximepichou and @rreubenreyes for reporting.

General

License
MIT
Typescript Types
Built-in
Tree-shakeable
Yes

Popularity

GitHub Stargazers
3,028
Community Interest
2,905
Number of Forks
293

Maintenance

Commits
10/219/220250
Last Commit
Open Issues
6
Closed Issues
407
Open Pull Requests
1
Closed Pull Requests
149

Versions

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

Dependencies

Dependencies (2)
Dev Dependencies (2)

Contributors

willfarrell
willfarrell
Commits: 384
lmammino
lmammino
Commits: 113
greenkeeper[bot]
greenkeeper[bot]
Commits: 12
vladgolubev
vladgolubev
Commits: 12
thejuan
thejuan
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
munierujp
munierujp
Commits: 4
sdomagala
sdomagala
Commits: 4
denovodavid
denovodavid
Commits: 3