Skip to content

Commit ae32f43

Browse files
Update to README about options and limitations
1 parent 568a1cc commit ae32f43

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,19 @@ Install
99
npm install express-fileupload
1010

1111

12+
Important Note
13+
==============
14+
Add `app.use(fileUpload())` AFTER `app.use(bodyParser.json)` and any other bodyParser middlewares! This limitation will be explored and resolved in an upcoming release.
15+
16+
Options
17+
=======
18+
Pass in Busboy options directly to express-fileupload (using Busboy `v0.2.13`). Check out the Busboy documentation here: https://github.com/mscdex/busboy#api
19+
```javascript
20+
app.use(fileUpload({
21+
limits: { fileSize: 50 * 1024 * 1024 },
22+
}));
23+
```
24+
1225
Example
1326
=======
1427

@@ -60,4 +73,4 @@ app.post('/upload', function(req, res) {
6073

6174
## Thanks & Credit
6275

63-
* [Brian White](https://github.com/mscdex) for his stellar work on the [Busboy Package](https://github.com/mscdex/busboy) and the [connect-busboy Package](https://github.com/mscdex/connect-busboy)
76+
* [Brian White](https://github.com/mscdex) for his stellar work on the [Busboy Package](https://github.com/mscdex/busboy) and the [connect-busboy Package](https://github.com/mscdex/connect-busboy)

0 commit comments

Comments
 (0)