Simple express middleware for uploading files.
# With NPMnpm install --save express-fileupload# With Yarnyarn add express-fileupload
When you upload a file, the file will be accessible from
- 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
The req.files.foo object will contain the following:
req.files.foo.mv: A function to move the file elsewhere on your server
req.files.foo.mimetype: The mimetype of your file
req.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 limit
req.files.foo.size: Uploaded size in bytes
req.files.foo.md5: MD5 checksum of the uploaded file
Notes about braking changes with md5 handling:
- Before 1.0.0
md5is a MD5 checksum of the uploaded file.
- In 1.0.0 and till 1.1.1
md5value 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.
Using Busboy Options
Pass in Busboy options directly to the express-fileupload middleware. Check out the Busboy documentation here.
Using useTempFile Options
Use temp files instead of memory for managing the upload process.
Note that this option available for versions 1.0.0 and newer.
Using debug option
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.
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...
Temporary file path is...says that
useTempfileswas set to true and also shows you temp file name and path.
New upload started testFile->car.pngsays that new upload started with field
testFileand file name
Uploading testFile->car.png, bytes:21232...shows current progress for each new data chunk.
Upload timeoutmeans that no data came during
Cleaning up temporary fileHere 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.
||Automatically creates the directory path specified in
||Applies uri decoding to file names if set true.|
||Strips characters from the upload's filename. You can use custom regex to determine what to strip. If set to
Example #1 (strip slashes from file names):
||Preserves filename extension when using
Example #1 (true):
myFileName.ext --> myFileName.ext
Example #2 (max extension length 2, extension shifted):
myFileName.ext --> myFileNamee.xt
||Returns a HTTP 413 when the file is bigger than the size limit if true. Otherwise, it will add a
||Response which will be send to client if file size limit exceeded when abortOnLimit set to true.|
||User defined limit handler which will be invoked if the file is bigger than configured limits.|
||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.|
||Used with the
||By default, req.body and req.files are flattened like this:
When this option is enabled they are parsed in order to be nested like this:
||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!