Skip to content

Commit c3507c4

Browse files
author
tunnckoCore
committed
update docs: document new options and the aliases
1 parent e67f42c commit c3507c4

2 files changed

Lines changed: 7 additions & 0 deletions

File tree

.verb.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ Accepts JSON, [JSON API v1](http://jsonapi.org/), text, buffer, [csp-report](htt
5151
- `multipart` **{Boolean}**: Default `true`. If you pass `false` it won't accept/parse multipart bodies.
5252
- `textLimit` **{String}**: Default `'100kb'`. Passed to [bytes][].parse method.
5353
- `formLimit` **{String}**: Default `'100kb'`. Passed to [bytes][].parse method.
54+
- `urlencodedLimit` **{String}**: Default `'100kb'`. Alias of `opts.formLimit`.
5455
- `jsonLimit` **{String}**: Default `'100kb'`. Passed to [bytes][].parse method.
5556
- `bufferLimit` **{String}**: Default `'1mb'`. Passed to [bytes][].parse method.
5657
- `jsonStrict` **{Boolean}**: Default `true`. When set to true, JSON parser will only accept arrays and objects.
@@ -62,6 +63,8 @@ Accepts JSON, [JSON API v1](http://jsonapi.org/), text, buffer, [csp-report](htt
6263
- `handler` **{GeneratorFunction}**: Works with `options.extendTypes.custom` to handle custom types of content-type - `handler(ctx, options, next)`. More info below.
6364
- `querystring` **{Object}**: Querystring module to be used. By default builtin [`querystring`](https://nodejs.org/api/querystring.html). More info below.
6465
- `qs` **{Object}**: Alias of `opts.querystring`. All `opts` are also passed to [qs][] or [querystring module](https://nodejs.org/api/querystring.html).
66+
- `delimiter` **{String}**: Default is `&`. Delimiter of key/value pairs, passed to querystring lib
67+
- `sep` **{String}**: alias of `opts.delimiter`
6568
- `buffer` **{Boolean}**: Default `false`, pass `true` if you want to get body as buffer.
6669

6770
## Note about `options.extendTypes`

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ Accepts JSON, [JSON API v1](http://jsonapi.org/), text, buffer, [csp-report](htt
7575
- `multipart` **{Boolean}**: Default `true`. If you pass `false` it won't accept/parse multipart bodies.
7676
- `textLimit` **{String}**: Default `'100kb'`. Passed to [bytes][].parse method.
7777
- `formLimit` **{String}**: Default `'100kb'`. Passed to [bytes][].parse method.
78+
- `urlencodedLimit` **{String}**: Default `'100kb'`. Alias of `opts.formLimit`.
7879
- `jsonLimit` **{String}**: Default `'100kb'`. Passed to [bytes][].parse method.
7980
- `bufferLimit` **{String}**: Default `'1mb'`. Passed to [bytes][].parse method.
8081
- `jsonStrict` **{Boolean}**: Default `true`. When set to true, JSON parser will only accept arrays and objects.
@@ -85,6 +86,9 @@ Accepts JSON, [JSON API v1](http://jsonapi.org/), text, buffer, [csp-report](htt
8586
- `IncomingForm` **{IncomingForm}**: Pass an instance of `formidable.IncomingForm` to be able to handle formidable events.
8687
- `handler` **{GeneratorFunction}**: Works with `options.extendTypes.custom` to handle custom types of content-type - `handler(ctx, options, next)`. More info below.
8788
- `querystring` **{Object}**: Querystring module to be used. By default builtin [`querystring`](https://nodejs.org/api/querystring.html). More info below.
89+
- `qs` **{Object}**: Alias of `opts.querystring`. All `opts` are also passed to [qs][] or [querystring module](https://nodejs.org/api/querystring.html).
90+
- `delimiter` **{String}**: Default is `&`. Delimiter of key/value pairs, passed to querystring lib
91+
- `sep` **{String}**: alias of `opts.delimiter`
8892
- `buffer` **{Boolean}**: Default `false`, pass `true` if you want to get body as buffer.
8993

9094
## Note about `options.extendTypes`

0 commit comments

Comments
 (0)