paginator-for-mongoose v3.2.0

Paginator For Mongoose

This library provides elegent way to paginate both simple and aggregate mongoose query.

Installation

npm install --save paginator-for-mongoose

Usage

Simple Query

const {paginate} = require('paginator-for-mongoose');

// usage with some mongoose model

let page = 1;

// limit is optional
const limit = 15;

const results = await paginate(Model.find({status: 'active'}), page, limit);

With Aggregate

const {paginateAggregate} = require('paginator-for-mongoose');

// usage with some mongoose model

let page = 1;

// limit is optional
const limit = 15;

const results = await paginateAggregate(Model.aggregate([{ $match: {status: 'active'} }]), page, limit);

Usage with Koa

const mongoose = require('mongoose');
const {enablePlugin, plugin} = require('paginator-for-mongoose');

// call this method to use schema plugin
enablePlugin(mongoose);

// or you can enable like mongoose.plugin(plugin);

// example usage in koajs controller

let page = 1;

// limit is optional, by default 15 items per page
// to change limit set ctx.PER_PAGE = 50, this will set 50 items per page

const results = await Model.aggregate([{ $match: {status: 'active'} }]).paginateAggregate(ctx);

// or for simple query
const results = await Model.find({status: 'active'}).paginate(ctx);

Using plugin on specific models

const mongoose = require('mongoose');
const {plugin} = require('paginator-for-mongoose');


Model.plugin(plugin);

// example usage in koajs controller

let page = 1;

// limit is optional
const limit = 15;

const results = await Model.aggregate([{ $match: {status: 'active'} }]).paginateAggregate(ctx);

// or for simple query
const results = await Model.find({status: 'active'}).paginate(ctx);

Ver 3

Paginate Using ID for large collections

 paginateById(User.find({ role: 'user' }))
        .then((docs) => {
          console.log(docs);
        })
        .catch((e) => console.error(e));

To paginate, pass last document id as second parameter. Third parameter is limit (Default: 50).

// pass last document id as second parameter
 paginateById(User.find({ role: 'user' }), '5e25a641beac1d5978ad2c14')
        .then((docs) => {
          console.timeEnd('Pagi');
          console.log(docs);
        })
        .catch((e) => console.error(e));

Using aggregate query. Second argument is id of last docuemnt and is optional for first page.

 paginateAggregateById(User.aggregate([{ $match: { role: 'user' } }]), '5e25a641beac1d5978ad2c14')
        .then((docs) => {
          console.log(docs);
        })
        .catch((e) => console.error(e));

Note: Pagination using id does not returns documents count because count is slow on large collections.