@openveo/api/lib/storages/factory.js

API for OpenVeo plugins

'use strict';

/**
 * @module storages/factory
 */

/**
 * Gets a [Storage]{@link module:storages/Storage~Storage} instance.
 *
 * @example
 * // Create a new Storage instance
 * var db = openVeoApi.storages.factory.get('mongodb', mongoDbConfiguration);
 *
 * @method get
 * @static
 * @param {String} type The expected storage type, could be "mongodb"
 * @param {Object} configuration A storage configuration object which depends on the storage type
 * @return {module:storages/Storage~Storage} The Storage instance
 * @throws {TypeError} If the specified storage type does not exist
 */
module.exports.get = function(type, configuration) {
  switch (type) {

    case 'mongodb':
      var MongoDatabase = process.requireApi('lib/storages/databases/mongodb/MongoDatabase.js');
      return new MongoDatabase(configuration);

    default:
      throw new TypeError('Unknown Storage type');
  }
};