express-form-post

Express Form Post

A simple solution to handling file and form submissions
Note: this is not recommended for use by applications that handle large files or receives a large volume of file upload requests. This is a quick solution to any application that handle small to medium sized files intended to be an abstraction for applications whose core doesn't come from file uploading.

Installation

$ npm install express-form-post --save

Usage

The information for the file uploaded will be available in the files and body object in the request object. express-form-post can be dropped in as middleware or used as a function to handle file upload. Check out the samples on the github repository for more specific usage!

Quick Start

var express = require("express");
var app = express();
var efp = require("express-form-post");
var formPost = efp();

app.use(formPost.middleware());

Disk Storage

var express = require("express");
var app = express();
var efp = require("express-form-post");
const formPost = efp({
	store: "disk",
	directory: path.join(__dirname, "tmp"),
	maxfileSize: 10000,
	filename: function(originalname, fieldname, mimetype) {
		return Date.now() + "-" + originalname;
	},
	validate: function(fieldname, originalname, mimetype) {
		console.log(mimetype);
		if(mimetype != "application/pdf") {
			return false;
		}
	}
});

app.use(formPost.middleware(function(err) {
	if(err) console.log(err);
	console.log("Here are my files:", req.files);
}));

Usage with aws-s3

$ npm install aws-sdk --save

var express = require("express");
var app = express();
var efp = require("express-form-post");
const formPost = efp({
	store: "aws-s3",
	maxfileSize: 100000,
	filename: function(originalname, fieldname, mimetype) {
		return originalname;
	},
	api: {
		accessKeyId: process.env.AWS_ACCESS_KEY_ID,
		secretAccessKey: process.env.secretAccessKey,
		bucketName: process.env.S3_BUCKET_NAME,
		ACL: "public-read"
	}
})

app.use(formPost.middleware(function(err) {
	if(err) console.log(err);
	console.log("Here are my files", req.files);
}));

Usage with dropbox

$ npm install dropbox --save

var express = require("express");
var app = express();
var efp = require("express-form-post");
const formPost = efp({
	store: "dropbox",
	filename: function(originalname, fieldname, mimetype) {
		return originalname;
	},
	api: {
		accessToken: process.env.dropboxAccessToken
	}
});

app.use(formPost.middleware(function(err) {
	if(err) console.log(err);
	console.log("Here are my files", req.files);
}));

Usage as an asynchronous function

app.post("*", (req, res, next) => { 
	formPost.upload(req, res, (err) => {
		if(err) {
			console.log(err);
		}
		console.log("My files are located here:", req.files);
		res.redirect("/");
	});
}

express-form-post API

When initializing an instance of efp (express-form-post) you can provide it different options that will change the way efp handles your file uploads.

express-form-post(opts)

express-form-post accepts an "optional" options parameter list. Keep in mind all fields are OPTIONAL. If you don't provide any, the express-form-post api will take care of that using the default options.

Key	Description	Note
store	The type of store	check below for available store methods
directory	The folder to which the file will be saved	defaults to current directory
filename	function to determine file save name	defaults to the file's name on the user's computer
maxfileSize	Maximum Size of the uploaded file in bytes	defaults to infiniti
minfileSize	Minimum Size of the uploaded file in bytes	defaults to 0
validate	function to validate uploaded file
api	api configuration information (api keys)	read further documentation for specifications

Available storage methods

• disk storage
• aws s3
• dropbox

Configuring API storage

Here are the different information you can input for each api storage. These options would go inside the api property of the options listed above.

aws-s3

Key	Description	Note
accessKeyId	AWS access key id	This is required. You can find it here : aws console
secretAccessKey	secret key for aws	Optional based on your s3 settings
bucketName	The name of your bucket.	This is required.
ACL	Access control list	Privacy control. Defaults to "private"

dropbox

Key	Description	Note
accessToken	used by Dropbox to identify your app	This is required. Check out the docs
clientId	Dropbox client Id	Optional
selectUser	Specific user in a team box	Optional