4.0.2 • Published 9 years ago

mongo-pages v4.0.2

Weekly downloads
6
License
-
Repository
github
Last release
9 years ago

mongo-pages Build Status

Mongoose ORM (NodeJS/MongoDB) Document Query Pagination

This is a fork of Edward Hotchkiss's mongoose-paginate package, with some additions needed for the CS Blogs project.

To be used in combination with view pagination middleware such as express-paginate.

Installation

npm install -S mongo-pages

Usage

Basic

/*
 * basic example usage of `mongo-pages`
 * querying for `all` {} items in `MyModel`
 * paginating by second page, 10 items per page (10 results, page 2)
 */

var mongoPages = require('mongo-pages');

MyModel.plugin(mongoPages);

MyModel.paginate({}, {
    page: 2,
    limit: 10
    }, function(error, page) {
      if (error) {
        console.error(error);
      } else {
        console.log('Pages:', page.pageCount);
        console.log(page.results);
      }
});

Advanced

/*
 * advanced example usage of `mongo-pages`
 * querying for `{ columns: 'title', { populate: 'some_ref' }, { sortBy : { title : -1 } }` items in `MyModel`
 * paginating by second page, 10 items per page (10 results, page 2)
 */

var mongoPages = require('mongo-pages');

MyModel.plugin(mongoPages);

MyModel.paginate({}, {
    page: 2,
    limit: 10,
    columns: 'title',
    populate: 'some_ref',
    sortBy: { title : -1 }
    }, function(error, page) {
      if (error) {
        console.error(error);
      } else {
        console.log('Pages:', page.pageCount);
        console.log(page.results);
      }
});

Author: Edward Hotchkiss

Contributors