From a765ea31ab8c3c24be6be8fd22b1149a5b7c5f93 Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Tue, 6 May 2014 14:18:10 -0700 Subject: [PATCH] Correct JSDoc for discoverModelDefinitions --- lib/datasource.js | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/lib/datasource.js b/lib/datasource.js index 283f4f6e..e20d481e 100644 --- a/lib/datasource.js +++ b/lib/datasource.js @@ -718,7 +718,7 @@ DataSource.prototype.defineProperty = function (model, prop, params) { * Drop each model table and re-create. * This method applies only to SQL connectors. * - * @param {String} Models to be migrated, if not present, apply to all models. This can also be an array of Strings. + * @param {String} model Model to migrate. If not present, apply to all models. Can also be an array of Strings. * @param {Function} cb Callback function. Optional. * * WARNING: Calling this function will cause all data to be lost! Use autoupdate if you need to preserve data. @@ -740,7 +740,7 @@ DataSource.prototype.automigrate = function (models, cb) { * Update existing database tables. * This method make sense only for sql connectors. * - * @param {String} Models to be migrated, if not present, apply to all models. This can also be an array of Strings. + * @param {String} model Model to migrate. If not present, apply to all models. Can also be an array of Strings. * @param {Function} [cb] The callback function */ DataSource.prototype.autoupdate = function (models, cb) { @@ -760,15 +760,16 @@ DataSource.prototype.autoupdate = function (models, cb) { * Discover existing database tables. * This method returns an array of model objects, including {type, name, onwer} * - * Kyes in options object: - * - * - all: true - Discovering all models, false - Discovering the models owned by the current user - * - views: true - Including views, false - only tables - * - limit: The page size - * - offset: The starting index - * * @param {Object} options The options * @param {Function} Callback function. Optional. + * @options {Object} options Discovery options. + * + * Keys in options object: + * + * @property all {Boolean} If true, discover all models; if false, discover only models owned by the current user. + * @property views {Boolean} If true, nclude views; if false, only tables. + * @property limit {Number} Page size + * @property offset {Number} Starting index * */ DataSource.prototype.discoverModelDefinitions = function (options, cb) {