http-body v1.0.11

http-body

Parse the stream body into text/json/buffer/urlencoded (437 bytes).

Install

$ npm install http-body --save

Usage

const { buffer, text, json, urlencoded } = require('http-body')

/* into buffer */
await buffer(req)
// => <Buffer 7b 22 70 72 69 63 65 22 3a 20 39 2e 39 39 7d>

/* into text */
await text(req)
// => '{"price": 9.99}'

/* into json */
await json(req)
// => { price: '9.99' }

/* into URLSearchParams */
await urlencoded(req)
// => 'price=9.99'

The max body size allowed by default is 1 MB. That can be customize as second argument:

const { buffer, text, json, urlencoded } = require('http-body')
const bytes = require('bytes')

await buffer(req, { limit: bytes('1mb')})
// => TypeError: body size (1112140) is over the limit (1048576)

API

text(req, options)

Converts request body to string.

urlencoded(req, options)

Parses request body using new URLSearchParams.

json(req, options)

Parses request body using JSON.parse.

buffer(req, options)

Minimal body parsing without any formatting.

Options

limit

Type: number Default: 1048576

The max body size allowed.

If the request body exceeds it, it throws an error.

License

http-body © Kiko Beats, released under the MIT License. Authored and maintained by Kiko Beats with help from contributors.

kikobeats.com · GitHub Kiko Beats · Twitter @Kikobeats