verdnatura-mirror
/
loopback-component-storage
mirror of https://github.com/strongloop/loopback-component-storage.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add param info to constructor JSDoc

This commit is contained in:
crandmck 2014-04-07 16:32:12 -07:00
parent bb6567c439
commit a58ed7711f
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
lib/storage-service.js
View File

@ -11,8 +11,16 @@ module.exports = StorageService;
*
* @options {Object} options The options to create a provider; see below.
* @prop {Object} connector <!-- What is this? -->
* @prop {String} provider Use 'filesystem' for local file system. Other supported values are: 'amazon', 'rackspace', 'azure', and 'openstack'.
* @prop {String} root With 'filesystem' provider, the path to the root of storage directory.
* @prop {String} provider Storage service provider. Must be one of:
* <ul><li>'filesystem' - local file system.</li>
* <li>'amazon'</li>
* <li>'rackspace'</li>
* <li>'azure'</li>
* <li>'openstack'</li>
* </ul>
*
* Other supported values depend on the provider.
* See the [documentation](http://docs.strongloop.com/display/DOC/Storage+service) for more information.
* @class
*/
function StorageService(options) {
@ -76,7 +84,8 @@ StorageService.prototype.getContainers = function (cb) {
* <li>'openstack'</li>
* </ul>
*
* Other supported values depend on the provider. See the [documentation](http://docs.strongloop.com/display/DOC/Storage+service) for more information.
* Other supported values depend on the provider.
* See the [documentation](http://docs.strongloop.com/display/DOC/Storage+service) for more information.
* @callback {Function} callback Callback function.
*/