Simple express file upload middleware that wraps around busboy

Richard Girges b93e40301e 1.0.0		6 years ago
example	update docs to check for empty object	6 years ago
lib	Pass options to File Factory	6 years ago
test	Major breaking change: update file `md5` property to be a method, allowing users to execute it at will. This will speed up performance, in addition to ensuring that md5() does not increase memory allocation size for users that do not care about md5 checksums	6 years ago
.eslintignore	added eslintignore	7 years ago
.eslintrc	fix merge conflicts; split the library up into separate files to promote easier testability	6 years ago
.gitignore	upgrade packages. disable yarn.lock in favor of package-lock being the single source of truth.	6 years ago
.travis.yml	add node 10 to CI	6 years ago
LICENSE	Initial commit	9 years ago
README.md	readme breaking change update	6 years ago
package-lock.json	1.0.0	6 years ago
package.json	1.0.0	6 years ago

express-fileupload

Simple express middleware for uploading files.

Version 1.0.0 Breaking Changes

Breaking change to md5 handling. Read about it here.

# 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 server
req.files.foo.mimetype: The mimetype of your file
req.files.foo.data: A buffer representation of your file
req.files.foo.truncated: A boolean that represents if the file is over the size limit
req.files.foo.md5: A function that returns an MD5 checksum of the uploaded file

Pass in Busboy options directly to the express-fileupload middleware. Check out the Busboy documentation here.

app.use(fileUpload({
  limits: { fileSize: 50 * 1024 * 1024 },
}));

Pass in non-Busboy options directly to the middleware. These are express-fileupload specific options.

Option	Acceptable Values	Details
createParentPath	`false` (default) `true`	Automatically creates the directory path specified in `.mv(filePathName)`
safeFileNames	`false` (default) `true` regex	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	`false` (default) `true` `Number`	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	`false` (default) `true`	Returns a HTTP 413 when the file is bigger than the size limit if true. Otherwise, it will add a `truncate = true` to the resulting file structure.

Pull Requests are welcomed!