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

Fix jsdocs for methods with where argument

This commit is contained in:
Raymond Feng 2015-07-28 08:29:43 -07:00
parent 9422175510
commit 0f9dd93aba
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
lib/persisted-model.js
View File

@ -114,7 +114,7 @@ module.exports = function(registry) {
* Returns an object, not collection. * Returns an object, not collection.
* If not found, create the object using data provided as second argument. * If not found, create the object using data provided as second argument.
* *
* @param {Object} where Where clause, such as `{where: {test: 'me'}}` * @param {Object} where Where clause, such as `{test: 'me'}`
* <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 Data to insert if object matching the `where` filter is not found. * @param {Object} data Data to insert if object matching the `where` filter is not found.
* @callback {Function} callback Callback function called with `cb(err, instance)` arguments. Required. * @callback {Function} callback Callback function called with `cb(err, instance)` arguments. Required.
@ -224,7 +224,7 @@ module.exports = function(registry) {
* *
* @param {Object} [where] Optional where filter, like: * @param {Object} [where] Optional where filter, like:
* ``` * ```
* {where: { key: val, key2: {gt: 'val2'}, ...} } * {key: val, key2: {gt: 'val2'}, ...}
* ``` * ```
* <br/>See [Where filter](http://docs.strongloop.com/display/LB/Where+filter). * <br/>See [Where filter](http://docs.strongloop.com/display/LB/Where+filter).
* *
@ -261,7 +261,7 @@ module.exports = function(registry) {
* *
* @param {Object} [where] Optional `where` filter, like * @param {Object} [where] Optional `where` filter, like
* ``` * ```
* {where: { key: val, key2: {gt: 'val2'}, ...}} * { key: val, key2: {gt: 'val2'}, ...}
* ``` * ```
* <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.
@ -305,7 +305,7 @@ module.exports = function(registry) {
* Return the number of records that match the optional "where" filter. * Return the number of records that match the optional "where" filter.
* @param {Object} [where] Optional where filter, like * @param {Object} [where] Optional where filter, like
* ``` * ```
* {where: { key: val, key2: {gt: 'val2'}, ...} } * { key: val, key2: {gt: 'val2'}, ...}
* ``` * ```
* <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 Callback function called with `(err, count)` arguments. Required. * @callback {Function} callback Callback function called with `(err, count)` arguments. Required.