From caf53f72c1794c5d70823d33891059c76bfbc9d0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miroslav=20Bajto=C5=A1?= Date: Thu, 26 Mar 2015 19:06:56 +0100 Subject: [PATCH] Fix API doc for updateAll/deleteAll Based on changes made in https://github.com/strongloop/loopback/issues/1167 https://github.com/strongloop/loopback-datasource-juggler/pull/540 --- lib/persisted-model.js | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/lib/persisted-model.js b/lib/persisted-model.js index 90a5c861..31c318a0 100644 --- a/lib/persisted-model.js +++ b/lib/persisted-model.js @@ -219,8 +219,10 @@ PersistedModel.findOne = function findOne(params, cb) { * ``` *
See [Where filter](http://docs.strongloop.com/display/LB/Where+filter). * - * @callback {Function} callback Optional callback function called with `(err)` argument. + * @callback {Function} callback Optional callback function called with `(err, info)` arguments. * @param {Error} err Error object; see [Error object](http://docs.strongloop.com/display/LB/Error+object). + * @param {Object} info Additional information about the command outcome. + * @param {Number} info.count Number of instances (rows, documents) destroyed. */ PersistedModel.destroyAll = function destroyAll(where, cb) { @@ -243,7 +245,7 @@ PersistedModel.deleteAll = PersistedModel.destroyAll; * Example: * *```js - * Employee.updateAll({managerId: 'x001'}, {managerId: 'x002'}, function(err, count) { + * Employee.updateAll({managerId: 'x001'}, {managerId: 'x002'}, function(err, info) { * ... * }); * ``` @@ -255,9 +257,10 @@ PersistedModel.deleteAll = PersistedModel.destroyAll; *
see [Where filter](http://docs.strongloop.com/display/public/LB/Where+filter). * @param {Object} data Object containing data to replace matching instances, if any. * - * @callback {Function} callback Callback function called with `(err, count)` arguments. Required. + * @callback {Function} callback Callback function called with `(err, info)` arguments. Required. * @param {Error} err Error object; see [Error object](http://docs.strongloop.com/display/LB/Error+object). - * @param {Number} count Number of instances updated. + * @param {Object} info Additional information about the command outcome. + * @param {Number} info.count Number of instances (rows, documents) updated. * */ PersistedModel.updateAll = function updateAll(where, data, cb) {