periodicjs.core.files
Periodic's Code files module exports helper functions to handle multi-part form data. periodic.core.files
uses Busyboy
to parse form data from an HTTP reqest.
Installation
$ npm install periodicjs.core.files
This is a part of Periodic's core.
Usage
Sending Emails
JavaScript
const CoreFiles = ;//mounted inside of periodic on periodic.core.filesconst periodic = ;const fs = ;const encryption_key = fs ||'encryption_password';const createFileMiddleware = periodiccorefiles;const createEncryptedFileMiddleware = periodiccorefiles;const removeFileMiddleware = periodiccorefiles;const decrypteFileMiddleware = periodiccorefiles); const testFileRouter = periodicexpress; testFileRouter;testFileRouter;testFileRouter;testFileRouter;testFileRouter;
API
CoreFiles;// => new asset docCoreFiles;//options.filename,options.req => new file stringCoreFiles;//options.req,options.periodic,options.upload_dir => {dir path info}CoreFiles;// - busboy file handlerCoreFiles;//fieldname, val - busboy form field handlerCoreFiles;//options.req,options.res,options.next - send http reponse or redirectsCoreFiles;//options.req,options.res,options.next - callback for busboy form processing completionCoreFilesuploadMiddlewareHandlerDefaultOptions;CoreFiles;//busboy multipart form handlerCoreFiles;//returns bound uploadMiddleware function with optionsCoreFilesremoveMiddlewareHandlerDefaultOptions;CoreFiles;//removes file from disk and dbCoreFiles;//returns bound removeMiddleware function with optoinsCoreFilesdecryptAssetMiddlewareHandlerDefaultOptions;CoreFiles;//decrypts encrypted file and pipes file content to responseCoreFiles;//returns bound decryptAssetMiddleware function with options
Development
Make sure you have grunt installed
$ npm install -g grunt-cli
For tests
$ grunt test && grunt coveralls
For generating documentation
$ grunt doc
$ jsdoc2md lib/**/*.js > doc/api.md
Notes
- Check out https://github.com/typesettin/periodicjs for the full Periodic Documentation