aboutsummaryrefslogtreecommitdiffstats
path: root/dgbuilder/dgeflows/node_modules/body-parser/node_modules/raw-body/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'dgbuilder/dgeflows/node_modules/body-parser/node_modules/raw-body/README.md')
-rw-r--r--dgbuilder/dgeflows/node_modules/body-parser/node_modules/raw-body/README.md95
1 files changed, 0 insertions, 95 deletions
diff --git a/dgbuilder/dgeflows/node_modules/body-parser/node_modules/raw-body/README.md b/dgbuilder/dgeflows/node_modules/body-parser/node_modules/raw-body/README.md
deleted file mode 100644
index 9b610b20..00000000
--- a/dgbuilder/dgeflows/node_modules/body-parser/node_modules/raw-body/README.md
+++ /dev/null
@@ -1,95 +0,0 @@
-# raw-body
-
-[![NPM version][npm-image]][npm-url]
-[![Build status][travis-image]][travis-url]
-[![Test coverage][coveralls-image]][coveralls-url]
-[![Dependency Status][david-image]][david-url]
-[![License][license-image]][license-url]
-[![Downloads][downloads-image]][downloads-url]
-
-Gets the entire buffer of a stream either as a `Buffer` or a string.
-Validates the stream's length against an expected length and maximum limit.
-Ideal for parsing request bodies.
-
-## API
-
-```js
-var getRawBody = require('raw-body')
-var typer = require('media-typer')
-
-app.use(function (req, res, next) {
- getRawBody(req, {
- length: req.headers['content-length'],
- limit: '1mb',
- encoding: typer.parse(req.headers['content-type']).parameters.charset
- }, function (err, string) {
- if (err)
- return next(err)
-
- req.text = string
- next()
- })
-})
-```
-
-or in a Koa generator:
-
-```js
-app.use(function* (next) {
- var string = yield getRawBody(this.req, {
- length: this.length,
- limit: '1mb',
- encoding: this.charset
- })
-})
-```
-
-### getRawBody(stream, [options], [callback])
-
-Returns a thunk for yielding with generators.
-
-Options:
-
-- `length` - The length 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.
- If the body ends up being larger than this limit,
- a `413` error code is returned.
-- `encoding` - The requested encoding.
- By default, a `Buffer` instance will be returned.
- Most likely, you want `utf8`.
- You can use any type of encoding supported by [iconv-lite](https://www.npmjs.org/package/iconv-lite#readme).
-
-You can also pass a string in place of options to just specify the encoding.
-
-`callback(err, res)`:
-
-- `err` - the following attributes will be defined if applicable:
-
- - `limit` - the limit in bytes
- - `length` and `expected` - the expected length of the stream
- - `received` - the received bytes
- - `encoding` - the invalid encoding
- - `status` and `statusCode` - the corresponding status code for the error
- - `type` - either `entity.too.large`, `request.size.invalid`, `stream.encoding.set`, or `encoding.unsupported`
-
-- `res` - the result, either as a `String` if an encoding was set or a `Buffer` otherwise.
-
-If an error occurs, the stream will be paused, everything unpiped,
-and you are responsible for correctly disposing the stream.
-For HTTP requests, no handling is required if you send a response.
-For streams that use file descriptors, you should `stream.destroy()` or `stream.close()` to prevent leaks.
-
-[npm-image]: https://img.shields.io/npm/v/raw-body.svg?style=flat-square
-[npm-url]: https://npmjs.org/package/raw-body
-[travis-image]: https://img.shields.io/travis/stream-utils/raw-body.svg?style=flat-square
-[travis-url]: https://travis-ci.org/stream-utils/raw-body
-[coveralls-image]: https://img.shields.io/coveralls/stream-utils/raw-body.svg?style=flat-square
-[coveralls-url]: https://coveralls.io/r/stream-utils/raw-body
-[david-image]: http://img.shields.io/david/stream-utils/raw-body.svg?style=flat-square
-[david-url]: https://david-dm.org/stream-utils/raw-body
-[license-image]: http://img.shields.io/npm/l/raw-body.svg?style=flat-square
-[license-url]: LICENSE
-[downloads-image]: http://img.shields.io/npm/dm/raw-body.svg?style=flat-square
-[downloads-url]: https://npmjs.org/package/raw-body