Simple express middleware for uploading files.
# With NPM
npm install --save express-fileupload
# With Yarn
yarn add express-fileupload
When you upload a file, the file will be accessible from req.files
.
Example:
- You're uploading a file called car.jpg
- Your input's name field is foo:
<input name="foo" type="file" />
- In your express server request, you can access your uploaded file from
req.files.foo
:
app.post('/upload', function(req, res) {
console.log(req.files.foo); // the uploaded file object
});
The req.files.foo object will contain the following:
req.files.foo.name
: "car.jpg"req.files.foo.mv
: A function to move the file elsewhere on your serverreq.files.foo.mimetype
: The mimetype of your filereq.files.foo.data
: A buffer representation of your file, returns empty buffer in case useTempFiles option was set to true.req.files.foo.tempFilePath
: A path to the temporary file in case useTempFiles option was set to true.req.files.foo.truncated
: A boolean that represents if the file is over the size limitreq.files.foo.size
: Uploaded size in bytesreq.files.foo.md5
: MD5 checksum of the uploaded file
Notes about braking changes with md5 handling:
- Before 1.0.0
md5
is a MD5 checksum of the uploaded file. - In 1.0.0 and till 1.1.1
md5
value is a function to compute md5 hash Read about it here. - From 1.1.1 it was reverted back to MD5 checksum value and also added full md5 support in case of using temporary files.
Pass in Busboy options directly to the express-fileupload middleware. Check out the Busboy documentation here.
app.use(fileUpload({
limits: { fileSize: 50 * 1024 * 1024 },
}));
Use temp files instead of memory for managing the upload process.
app.use(fileUpload({
useTempFiles : true,
tempFileDir : '/tmp/'
}));
You can set debug
option to true
to see some logging about upload process.
In this case middleware uses console.log
and adds Express-file-upload
prefix for outputs.
It will show you whether the request is illigable and also common events triggered during upload. That can be really usfull for troubleshhoting and we recommend to attach debug output to each issue on Github.
Output example:
Express-file-upload: Temporary file path is /node/express-fileupload/test/temp/tmp-16-1570084843942
Express-file-upload: New upload started testFile->car.png, bytes:0
Express-file-upload: Uploading testFile->car.png, bytes:21232...
Express-file-upload: Uploading testFile->car.png, bytes:86768...
Express-file-upload: Upload timeout testFile->car.png, bytes:86768
Express-file-upload: Cleaning up temporary file /node/express-fileupload/test/temp/tmp-16-1570084843942...
Description:
Temporary file path is...
says thatuseTempfiles
was set to true and also shows you temp file name and path.New upload started testFile->car.png
says that new upload started with fieldtestFile
and file namecar.png
.Uploading testFile->car.png, bytes:21232...
shows current progress for each new data chunk.Upload timeout
means that no data came duringuploadTimeout
.Cleaning up temporary file
Here finaly we see cleaning up of the temporary file because of upload timeout reached.
Pass in non-Busboy options directly to the middleware. These are express-fileupload specific options.
Option | Acceptable Values | Details |
---|---|---|
createParentPath |
|
Automatically creates the directory path specified in .mv(filePathName) |
uriDecodeFileNames |
|
Applies uri decoding to file names if set true. |
safeFileNames |
|
Strips characters from the upload's filename. You can use custom regex to determine what to strip. If set to true , non-alphanumeric characters except dashes and underscores will be stripped. This option is off by default.Example #1 (strip slashes from file names): app.use(fileUpload({ safeFileNames: /\\/g })) Example #2: app.use(fileUpload({ safeFileNames: true })) |
preserveExtension |
|
Preserves filename extension when using safeFileNames option. If set to true , will default to an extension length of 3. If set to Number , this will be the max allowable extension length. If an extension is smaller than the extension length, it remains untouched. If the extension is longer, it is shifted.Example #1 (true): app.use(fileUpload({ safeFileNames: true, preserveExtension: true })); myFileName.ext --> myFileName.ext Example #2 (max extension length 2, extension shifted): app.use(fileUpload({ safeFileNames: true, preserveExtension: 2 })); myFileName.ext --> myFileNamee.xt |
abortOnLimit |
|
Returns a HTTP 413 when the file is bigger than the size limit if true. Otherwise, it will add a truncated = true to the resulting file structure. |
responseOnLimit |
|
Response which will be send to client if file size limit exceeded when abortOnLimit set to true. |
limitHandler |
|
User defined limit handler which will be invoked if the file is bigger than configured limits. |
useTempFiles |
|
Will use temporary files at the specified tempDir for managing uploads rather than using buffers in memory. This avoids memory issues when uploading large files. |
tempFileDir |
|
Used with the useTempFiles option. Path to the directory where temp files will be stored during the upload process. Feel free to add trailing slash, but it is not necessary. |
parseNested |
|
By default, req.body and req.files are flattened like this: {'name': 'John', 'hobbies[0]': 'Cinema', 'hobbies[1]': 'Bike'} When this option is enabled they are parsed in order to be nested like this: {'name': 'John', 'hobbies': ['Cinema', 'Bike']} |
debug |
|
Turn on/off upload process logging. Can be usefull for troubleshooting. |
Looking for additional maintainers. Please contact richardgirges [ at ] gmail.com
if you're interested. Pull Requests are welcomed!
Brian White for his stellar work on the Busboy Package and the connect-busboy Package