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

Merge pull request #1252 from strongloop/fix/updateall-deleteall-jsdoc 

Improve API docs
This commit is contained in:
Miroslav Bajtoš 2015-03-26 19:20:31 +01:00
parent 4a8c3be8f4 2ca621e597
commit e69eba6560
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
lib/persisted-model.js
View File

@ -219,8 +219,10 @@ PersistedModel.findOne = function findOne(params, cb) {
* ``` * ```
* <br/>See [Where filter](http://docs.strongloop.com/display/LB/Where+filter). * <br/>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 {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) { PersistedModel.destroyAll = function destroyAll(where, cb) {
@ -243,7 +245,7 @@ PersistedModel.deleteAll = PersistedModel.destroyAll;
* Example: * Example:
* *
*```js *```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;
* <br/>see [Where filter](http://docs.strongloop.com/display/public/LB/Where+filter). * <br/>see [Where filter](http://docs.strongloop.com/display/public/LB/Where+filter).
* @param {Object} data Object containing data to replace matching instances, if any. * @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 {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) { PersistedModel.updateAll = function updateAll(where, data, cb) {
@ -819,6 +822,8 @@ PersistedModel.currentCheckpoint = function(cb) {
* @callback {Function} [callback] Callback function called with `(err, conflicts)` arguments. * @callback {Function} [callback] Callback function called with `(err, conflicts)` arguments.
* @param {Error} err Error object; see [Error object](http://docs.strongloop.com/display/LB/Error+object). * @param {Error} err Error object; see [Error object](http://docs.strongloop.com/display/LB/Error+object).
* @param {Conflict[]} conflicts A list of changes that could not be replicated due to conflicts. * @param {Conflict[]} conflicts A list of changes that could not be replicated due to conflicts.
* @param {Object] checkpoints The new checkpoints to use as the "since"
* argument for the next replication.
*/ */
PersistedModel.replicate = function(since, targetModel, options, callback) { PersistedModel.replicate = function(since, targetModel, options, callback) {