Files
kami-parse-server/src/Adapters/Files/FilesAdapter.js
2016-03-24 14:15:00 -04:00

35 lines
1.0 KiB
JavaScript

// Files Adapter
//
// Allows you to change the file storage mechanism.
//
// Adapter classes must implement the following functions:
// * createFile(config, filename, data)
// * getFileData(config, filename)
// * getFileLocation(config, request, filename)
//
// Default is GridStoreAdapter, which requires mongo
// and for the API server to be using the DatabaseController with Mongo
// database adapter.
export class FilesAdapter {
/* this method is responsible to store the file in order to be retrived later by it's file name
*
* @param filename the filename to save
* @param data the buffer of data from the file
* @param contentType the supposed contentType
* @discussion the contentType can be undefined if the controller was not able to determine it
*
* @return a promise that should fail if the storage didn't succeed
*
*/
createFile(filename: string, data, contentType: string) { }
deleteFile(filename) { }
getFileData(filename) { }
getFileLocation(config, filename) { }
}
export default FilesAdapter;