Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tommy351 committed Jan 3, 2016
1 parent 09f6c1a commit 979c4ab
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions lib/model.js
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,6 @@ Model.prototype.new = function(data) {
* @param {*} id
* @param {object} options
* @param {boolean} [options.lean=false] Returns a plain JavaScript object
* @alias get
* @return {Document|object}
*/
Model.prototype.findById = function(id, options_) {
Expand Down Expand Up @@ -469,7 +468,7 @@ Model.prototype.size = Model.prototype.count;
* Iterates over all documents.
*
* @param {function} iterator
* @param {object} [options] See {@link Model.findById}.
* @param {object} [options] See {@link Model#findById}.
*/
Model.prototype.forEach = function(iterator, options) {
var keys = Object.keys(this.data);
Expand All @@ -487,7 +486,7 @@ Model.prototype.each = Model.prototype.forEach;
/**
* Returns an array containing all documents.
*
* @param {Object} [options] See {% crosslink Model.findById %}.
* @param {Object} [options] See {@link Model#findById}.
* @return {Array}
*/
Model.prototype.toArray = function(options) {
Expand Down Expand Up @@ -556,7 +555,7 @@ Model.prototype.findOne = function(query, options_) {
};

/**
* Sorts documents. See {% crosslink Query.sort %}.
* Sorts documents. See {@link Query#sort}.
*
* @param {String|Object} orderby
* @param {String|Number} [order]
Expand All @@ -574,7 +573,7 @@ Model.prototype.sort = function(orderby, order) {
* negative number.
*
* @param {Number} i
* @param {Object} [options] See {% crosslink Model.findById %}.
* @param {Object} [options] See {@link Model#findById}.
* @return {Document|Object}
*/
Model.prototype.eq = function(i_, options) {
Expand All @@ -600,7 +599,7 @@ Model.prototype.eq = function(i_, options) {
/**
* Returns the first document.
*
* @param {Object} [options] See {% crosslink Model.findById %}.
* @param {Object} [options] See {@link Model#findById}.
* @return {Document|Object}
*/
Model.prototype.first = function(options) {
Expand All @@ -610,7 +609,7 @@ Model.prototype.first = function(options) {
/**
* Returns the last document.
*
* @param {Object} [options] See {% crosslink Model.findById %}.
* @param {Object} [options] See {@link Model#findById}.
* @return {Document|Object}
*/
Model.prototype.last = function(options) {
Expand Down Expand Up @@ -691,7 +690,6 @@ Model.prototype.reverse = function() {
* Returns documents in random order.
*
* @return {Query}
* @alias random
*/
Model.prototype.shuffle = function() {
return new this.Query(shuffle(this.toArray()));
Expand Down

0 comments on commit 979c4ab

Please sign in to comment.