Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tether/inflate-body
Automatically unzip an HTTP stream and validate its buffer length
https://github.com/tether/inflate-body
body inflation raw zip zlib
Last synced: about 5 hours ago
JSON representation
Automatically unzip an HTTP stream and validate its buffer length
- Host: GitHub
- URL: https://github.com/tether/inflate-body
- Owner: tether
- License: mit
- Created: 2017-07-17T17:10:02.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-03-14T18:58:05.000Z (over 3 years ago)
- Last Synced: 2024-10-14T11:38:09.180Z (22 days ago)
- Topics: body, inflation, raw, zip, zlib
- Language: JavaScript
- Size: 4.88 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Inflate-Body
[](https://www.npmjs.com/package/inflate-body)
[](http://npm-stat.com/charts.html?package=inflate-body)
[](https://github.com/tether/contribution-guide)
Returns inflate data from a given HTTP stream and validate its buffer length against an expected length and maximum limit. This module is ideal for parsing HTTP request bodies with string encodings.
## Usage
```js
const http = require('http')
const inflate = require('inflat-body')
htpt.createServer((req, res) => {
inflate(req, options).then(str => {
// do something with request string
})
})
```
Options:
- `length` - The length of the stream.
If the contents of the stream do not add up to this length,
an `400` error code is returned.
- `limit` - The byte limit of the body.
This is the number of bytes or any string format supported by
[bytes](https://www.npmjs.com/package/bytes),
for example `1000`, `'500kb'` or `'3mb'`.
If the body ends up being larger than this limit,
a `413` error code is returned.
- `encoding` - The encoding to use to decode the body into a string.
By default, a `Buffer` instance will be returned when no encoding is specified.
Most likely, you want `utf-8`, so setting `encoding` to `true` will decode as `utf-8`.
You can use any type of encoding supported by [iconv-lite](https://www.npmjs.org/package/iconv-lite#readme).
## Installation
```shell
npm install inflate-body --save
```
[](https://nodei.co/npm/inflate-body/)
## Question
For support, bug reports and or feature requests please make sure to read our
community guidelines and use the issue list of this repo and make sure it's not present yet in our reporting checklist.
## Contribution
The open source community is very important to us. If you want to participate to this repository, please make sure to read our guidelines before making any pull request. If you have any related project, please let everyone know in our wiki.
## License
The MIT License (MIT)
Copyright (c) 2017 Tether Inc
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.