Skip to content

Documentation tidying #564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Documentation tidying #564

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 16 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,9 +278,14 @@ user response. There is currently no way to short-circuit this behavior.

#### limit

This sets the body size limit (default: `1mb`). If the body size is larger than the specified (or default) limit,
a `413 Request Entity Too Large` error will be returned. See [bytes.js](https://www.npmjs.com/package/bytes) for
a list of supported formats.
When `parseReqBody` is true, this is passed to `getRawBody`[https://www.npmjs.com/package/raw-body], and accepts the same arguments.

This limits the request body size when `parseReqBody` is true. (default: `1mb`).

If the body size is larger than the specified (or default) limit, a `413
Request Entity Too Large` error will be returned. See
[bytes.js](https://www.npmjs.com/package/bytes) for a list of supported
formats.

```js
app.use('/proxy', proxy('www.google.com', {
Expand Down Expand Up @@ -471,18 +476,19 @@ app.use('/proxy', proxy('www.google.com', {
```

#### parseReqBody
[default: true]

The `parseReqBody` option allows you to suppress parsing of the request
body. (The request body is parsed to make it available for modification and
decoration before being added to the proxy request.)

The ```parseReqBody``` option allows you to control parsing the request body.
For example, disabling body parsing is useful for large uploads where it would be inefficient
to hold the data in memory.

##### Note: this setting is required for binary uploads. A future version of this library may handle this for you.

This defaults to true in order to preserve legacy behavior.

When false, no action will be taken on the body and accordingly ```req.body``` will no longer be set.
When false, no action will be taken on the body and accordingly `req.body` will no longer be set.

Note that setting this to false overrides ```reqAsBuffer``` and ```reqBodyEncoding``` below.
#### Note: set this to false for binary uploads.
#### Note that setting this to false obviates `reqAsBuffer` and `reqBodyEncoding` settings.

```js
app.use('/proxy', proxy('www.google.com', {
Expand Down