diff --git a/docs.json b/docs.json index 32cef15..899aec4 100644 --- a/docs.json +++ b/docs.json @@ -1,8 +1,8 @@ { "content": [ { "title": "LoopBack Storage Service", "depth": 2 }, - "lib/storage-service.js", - { "title": "Storage Handler API", "depth": 3 }, - "lib/storage-handler.js" + "lib/storage-service.js", + { "title": "LoopBack Storage Connector", "depth": 2 }, + "lib/storage-connector.js" ] } diff --git a/lib/providers/filesystem/index.js b/lib/providers/filesystem/index.js index 85043eb..9285103 100644 --- a/lib/providers/filesystem/index.js +++ b/lib/providers/filesystem/index.js @@ -190,10 +190,10 @@ FileSystemProvider.prototype.download = function (options, cb) { } }; -FileSystemProvider.prototype.getFiles = function (container, download, cb) { - if (typeof download === 'function' && !(download instanceof RegExp)) { - cb = download; - download = false; +FileSystemProvider.prototype.getFiles = function (container, options, cb) { + if (typeof options === 'function' && !(options instanceof RegExp)) { + cb = options; + options = false; } var self = this; if (!validateName(container, cb)) return; diff --git a/lib/storage-connector.js b/lib/storage-connector.js index 8894d0d..b09360f 100644 --- a/lib/storage-connector.js +++ b/lib/storage-connector.js @@ -1,8 +1,10 @@ var StorageService = require('./storage-service'); /** - * Export the initialize method to Loopback data - * @param dataSource - * @param callback + * Initialize the storage service as a connector for LoopBack data sources + * @param {DataSource} dataSource DataSource instance + * @prop {Object} settings Connector settings + * @callback {Function} callback Callback function + * @param {String|Object} err Error string or object */ exports.initialize = function (dataSource, callback) { var settings = dataSource.settings || {}; diff --git a/lib/storage-service.js b/lib/storage-service.js index ea21e36..5382c3c 100644 --- a/lib/storage-service.js +++ b/lib/storage-service.js @@ -8,7 +8,7 @@ module.exports = StorageService; /** * Storage service constructor. Properties of options object depend on the storage service provider. * - * @options {Object} options The options to create a provider; see below. + * @options {Object} options Options to create a provider; see below. * @prop {String} provider Storage service provider. Must be one of: *