1. module mongoose-paginate
   1. function mongoose-paginate (schema)
   2. function mongoose-paginate.index (schema)
   3. function mongoose-paginate.paginate (query, options, callback)
2. module mongoose-paginate.index
   1. function mongoose-paginate.index (schema)
   2. function mongoose-paginate.index.paginate (query, options, callback)

module mongoose-paginate

function mongoose-paginate (schema)

• description and source-code

  mongoose-paginate = function (schema) {
      schema.statics.paginate = paginate;
  }

• example usage

  n/a

function mongoose-paginate.index (schema)

• description and source-code

  index = function (schema) {
      schema.statics.paginate = paginate;
  }

• example usage

  n/a

function mongoose-paginate.paginate (query, options, callback)

• description and source-code

  function paginate(query, options, callback) {
      query   = query || {};
      options = Object.assign({}, paginate.options, options);
  
      var select     = options.select;
      var sort       = options.sort;
      var populate   = options.populate;
      var lean       = options.lean || false;
      var leanWithId = options.hasOwnProperty('leanWithId') ? options.leanWithId : true;
  
      var limit = options.hasOwnProperty('limit') ? options.limit : 10;
      var skip, offset, page;
  
      if (options.hasOwnProperty('offset')) {
          offset = options.offset;
          skip   = offset;
      } else if (options.hasOwnProperty('page')) {
          page = options.page;
          skip = (page - 1) * limit;
      } else {
          offset = 0;
          page   = 1;
          skip   = offset;
      }
  
      var promises = {
          docs:  Promise.resolve([]),
          count: this.count(query).exec()
      };
  
      if (limit) {
          var query = this.find(query)
                          .select(select)
                          .sort(sort)
                          .skip(skip)
                          .limit(limit)
                          .lean(lean);
  
          if (populate) {
              [].concat(populate).forEach(function(item) {
                  query.populate(item);
              });
          }
  
          promises.docs = query.exec();
  
          if (lean && leanWithId) {
              promises.docs = promises.docs.then(function(docs) {
                  docs.forEach(function(doc) {
                      doc.id = String(doc._id);
                  });
  
                  return docs;
              });
          }
      }
  
      return Promise.props(promises)
          .then(function(data) {
              var result = {
                  docs:  data.docs,
                  total: data.count,
                  limit: limit
              };
  
              if (offset !== undefined) {
                  result.offset = offset;
              }
  
              if (page !== undefined) {
                  result.page  = page;
                  result.pages = Math.ceil(data.count / limit) || 1;
              }
  
              return result;
          })
          .asCallback(callback);
  }

• example usage

  n/a

module mongoose-paginate.index

function mongoose-paginate.index (schema)

• description and source-code

  index = function (schema) {
      schema.statics.paginate = paginate;
  }

• example usage

  n/a

function mongoose-paginate.index.paginate (query, options, callback)

• description and source-code

  function paginate(query, options, callback) {
      query   = query || {};
      options = Object.assign({}, paginate.options, options);
  
      var select     = options.select;
      var sort       = options.sort;
      var populate   = options.populate;
      var lean       = options.lean || false;
      var leanWithId = options.hasOwnProperty('leanWithId') ? options.leanWithId : true;
  
      var limit = options.hasOwnProperty('limit') ? options.limit : 10;
      var skip, offset, page;
  
      if (options.hasOwnProperty('offset')) {
          offset = options.offset;
          skip   = offset;
      } else if (options.hasOwnProperty('page')) {
          page = options.page;
          skip = (page - 1) * limit;
      } else {
          offset = 0;
          page   = 1;
          skip   = offset;
      }
  
      var promises = {
          docs:  Promise.resolve([]),
          count: this.count(query).exec()
      };
  
      if (limit) {
          var query = this.find(query)
                          .select(select)
                          .sort(sort)
                          .skip(skip)
                          .limit(limit)
                          .lean(lean);
  
          if (populate) {
              [].concat(populate).forEach(function(item) {
                  query.populate(item);
              });
          }
  
          promises.docs = query.exec();
  
          if (lean && leanWithId) {
              promises.docs = promises.docs.then(function(docs) {
                  docs.forEach(function(doc) {
                      doc.id = String(doc._id);
                  });
  
                  return docs;
              });
          }
      }
  
      return Promise.props(promises)
          .then(function(data) {
              var result = {
                  docs:  data.docs,
                  total: data.count,
                  limit: limit
              };
  
              if (offset !== undefined) {
                  result.offset = offset;
              }
  
              if (page !== undefined) {
                  result.page  = page;
                  result.pages = Math.ceil(data.count / limit) || 1;
              }
  
              return result;
          })
          .asCallback(callback);
  }

• example usage

  n/a