File uploader

Uploading files middleware for NodeJS, Express, TrinteJS, Connect.

Installation

Installation is done using the Node Package Manager (npm). If you don't have npm installed on your system you can download it from npmjs.org To install express-uploader:

$ npm install -g express-uploader

Usage overview

for TrinteJS

manual setup in project config/routes.js

1
2var Uploader = require('express-uploader');
3
4module.exports = function routes(map) {
5    ...
6    map.all('/upload', function(req, res, next) {
7        var uploader = new Uploader({
8            debug: true,
9            validate: true,
10            thumbnails: true,
11            thumbToSubDir: true,
12            tmpDir: __dirname + '/tmp',
13            publicDir: __dirname + '/public',
14            uploadDir: __dirname + '/public/files',
15            uploadUrl: '/files/',
16            thumbSizes: [140, [100, 100]]
17        });
18        uploader.uploadFile(req, function(data) {
19            res.send(JSON.stringify(data), {'Content-Type': 'text/plain'}, 200);
20        });
21    });
22};

for ExpressJS

1
2var Uploader = require('express-uploader');
3
4app.all('/upload', function(req, res, next) {
5    var uploader = new Uploader({
6        debug: true,
7        validate: true,
8        thumbnails: true,
9        thumbToSubDir: true,
10        tmpDir: __dirname + '/tmp',
11        publicDir: __dirname + '/public',
12        uploadDir: __dirname + '/public/files',
13        uploadUrl: '/files/',
14        thumbSizes: [140,[100, 100]]
15    });
16    uploader.uploadFile(req, function(data) {
17        res.send(JSON.stringify(data), {'Content-Type': 'text/plain'}, 200);
18    });
19});
20

Options

Name	Type	Default	Description
debug	boolean	false
safeName	boolean	true
validate	boolean	false
quality	number	80
thumbnails	boolean	false
thumbToSubDir	boolean	false
tmpDir	string	/tmp
publicDir	string	/public
uploadDir	string	/public/files
uploadUrl	string	/files/
maxPostSize	integer	11000000
minFileSize	integer	1
maxFileSize	integer	10000000
acceptFileTypes	regexp	/.+/i
thumbSizes	array	[[100, 100]]	[width, neight]
imageTypes	regexp	`/.(gif	jpe?g
resize	boolean	false	if need resize image
newSize	mixed	[800, 600]	new size for image [width, height]
crop	boolean	false	if need crop image
coordinates	object	{width:800,height:600,x:0,y:0}	coordinates for crop image { width:1200, height:800, x:0, y:0 }

In the Wild

The following projects use express-uploader.

If you are using express-uploader in a project, app, or module, get on the list below by getting in touch or submitting a pull request with changes to the README.

Recommend extensions

• Bootstrap Fancy File Plugin
• Bootstrap Ajax Typeahead Plugin
• TrinteJS - Javascrpt MVC Framework for Node.JS
• CaminteJS - Cross-db ORM for NodeJS
• MongoDB Session Storage for ExpressJS
• 2CO NodeJS adapter for 2checkout API payment gateway

Startups & Apps

• TViMama
• GorkaTV
• TrinteJS
• CaminteJS

Author

Aleksej Gordejev (aleksej@gordejev.lv).

License

(The MIT License)

Copyright (c) 2012 Aleksej Gordejev aleksej@gordejev.lv

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Resources

• Visit the author website.
• Follow @biggora on Twitter for updates.
• Report issues on the github issues page.