Skip to content

Commit

Permalink
Documented cursor constructor
Browse files Browse the repository at this point in the history
  • Loading branch information
notheotherben committed Apr 24, 2015
1 parent c306222 commit c2f13f1
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion lib/Cursor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,14 @@ import Promise = require('bluebird');
export = Cursor;

class Cursor<TDocument, TInstance> {
constructor(private model: model.Model<TDocument, TInstance>, private conditions: any, private cursor: MongoDB.Cursor) {
/**
* Creates a new Iridium cursor which wraps a MongoDB cursor object
* @param {Model} model The Iridium model that this cursor belongs to
* @param {Object} conditions The conditions that resulte in this cursor being created
* @param {MongoDB.Cursor} cursor The MongoDB native cursor object to be wrapped
* @constructor
*/
constructor(private model: model.Model<TDocument, TInstance>, private conditions: any, public cursor: MongoDB.Cursor) {

}

Expand Down

0 comments on commit c2f13f1

Please sign in to comment.