Mongoose plugin adding a file field to a schema - useful for nodejs file uploads
npm install mongoose-file
The plugin adds a file field to the mongoose schema. Assigning to the file property of the field causes (optionally) the file to be moved into place (see
upload_to below) and the field sub-properties to be assigned.
This field expects to be assigned (to its
file sub-field, as said) an object with a semantic like that of an expressjs request file object (see req.files).
Assigning to the field
file property caused the instance to be marked as modified (but it's not saved automatically).
name- original name of the uploaded file, without the directory components
path- the full final path where the uploaded file is stored
rel- path relative to a user specified directory (see the
type- the file type
size- the file size
lastModified- the uploaded file object
These values are extracted from the request-like file object received on assignment.
When attaching the plugin, it's possible to specify an options object containing the following parameters:
name- the field name (
name), which defaults to
change_cb- a callback function called whenever the file path is changed. It's called in the context of the model instance, and receives as parameters the field name, the new path value and the previous one.
upload_to- the directory name where the file will be moved from the temporary upload directory. If this is a function instead of a string, it will be called in the context of the model instance with the file object as a parameter, and it must return a string
relative_to- the base directory name used to construct the relative path stored in the
relsubfield. If this is a function, it will be called in the context of the model instance with the file object as a parameter. This can be useful to get a path usable from HTML, like in
var mongoose = require'mongoose';var filePluginLib = require'mongoose-file';var filePlugin = filePluginLibfilePlugin;var make_upload_to_model = filePluginLibmake_upload_to_model;var uploads_base = pathjoin__dirname "uploads";var uploads = pathjoinuploads_base "u";var SampleSchema =;SampleSchemapluginfilePluginname: "photo"upload_to: make_upload_to_modeluploads 'photos'relative_to: uploads_base;var SampleModel = dbmodel"SampleModel" SampleSchema;
mongoose = require 'mongoose'filePluginLib = require 'mongoose-file'filePlugin = filePluginLibfilePluginmake_upload_to_model = filePluginLibmake_upload_to_model...uploads_base = pathjoin__dirname"uploads"uploads = pathjoinuploads_base"u"...SampleSchema =...SampleSchemaplugin filePluginname: "photo"upload_to: make_upload_to_modeluploads'photos'relative_to: uploads_baseSampleModel = dbmodel"SampleModel"SampleSchema
Please use the github repository to notify bugs and make pull requests.
This software is © 2012 Marco Pantaleoni, released under the MIT licence. Use it, fork it.
See the LICENSE file for details.