
Security News
Crates.io Implements Trusted Publishing Support
Crates.io adds Trusted Publishing support, enabling secure GitHub Actions-based crate releases without long-lived API tokens.
mongoose-custom-pagination
Advanced tools
Pagination plugin for Mongoose
npm install mongoose-custom-pagination
Add plugin to a schema and then use model paginate
method:
var mongoose = require('mongoose');
var mongoosePaginate = require('mongoose-custom-pagination');
var schema = new mongoose.Schema({ /* schema definition */ });
schema.plugin(mongoosePaginate);
var Model = mongoose.model('Model', schema); // Model.paginate()
Returns promise
Parameters
[query]
{Object} - Query criteria. Documentation[options]
{Object}
[select]
{Object | String} - Fields to return (by default returns all fields). Documentation[sort]
{Object | String} - Sort order. Documentation[populate]
{Array | Object | String} - Paths which should be populated with other documents. Documentation[lean=false]
{Boolean} - Should return plain javascript objects instead of Mongoose documents? Documentation[leanWithId=true]
{Boolean} - If lean
and leanWithId
are true
, adds id
field with string representation of _id
to every document[offset=0]
{Number} - Use offset
or page
to set skip position[page=1]
{Number}[limit=10]
{Number}[customLabels]
{Object} - Developers can provide custom labels for the response data.[callback(err, result)]
- If specified the callback is called once pagination results are retrieved or when an error has occurredReturn value
Promise fulfilled with object having properties:
docs
{Array} - Array of documentstotalDocs
{Number} - Total number of documents in collection that match a querylimit
{Number} - Limit that was usedhasPrevPage
{Bool} - Availability of prev page.hasNextPage
{Bool} - Availability of next page.page
{Number} - Current page numbertotalPages
{Number} - Total number of pages.offset
{Number} - Only if specified or default page
/offset
values were usedprevPage
{Number} - Previous page number if available or NULLnextPage
{Number} - Next page number if available or NULLModel.paginate({}, { page: 1, limit: 10 }, function(err, result) {
// result.docs
// result.totalDocs = 100
// result.totalPages = 10
// result.limit = 10
// result.page = 1
// result.nextPage = 2
// result.prevPage = null
// result.hasNextPage = true
// result.hasPrevPage = false
});
Same query with custom labels
var myCustomLabels = {
docs: 'data',
nextPage: 'next',
prevPage: 'prev',
totalPages: 'pageCount'
};
Model.paginate({}, { page: 1, limit: 10 }, function(err, result) {
// result.docs <- here docs become data
// result.totalDocs = 100
// result.totalPages = 10
// result.limit = 10
// result.page = 1
// result.next = 2 <- here nextPage becomes next
// result.prev = null <- here prevPage becomes prev
// result.hasNextPage = true
// result.hasPrevPage = false
});
Or you can do the same with offset
and limit
:
Model.paginate({}, { offset: 20, limit: 10 }, function(err, result) {
// result.docs
// result.totalPages
// result.limit - 10
// result.offset - 20
});
With promise:
Model.paginate({}, { offset: 20, limit: 10 }).then(function(result) {
// ...
});
var query = {};
var options = {
select: 'title date author',
sort: { date: -1 },
populate: 'author',
lean: true,
offset: 20,
limit: 10
};
Book.paginate(query, options).then(function(result) {
// ...
});
You can use limit=0
to get only metadata:
Model.paginate({}, { offset: 100, limit: 0 }).then(function(result) {
// result.docs - empty array
// result.totalDocs
// result.limit - 0
// result.offset - 100
});
config.js:
var mongoosePaginate = require('mongoose-custom-pagination');
mongoosePaginate.paginate.options = {
lean: true,
limit: 20
};
controller.js:
Model.paginate().then(function(result) {
// result.docs - array of plain javascript objects
// result.limit - 20
});
FAQs
Mongoose custom pagination library.
The npm package mongoose-custom-pagination receives a total of 2 weekly downloads. As such, mongoose-custom-pagination popularity was classified as not popular.
We found that mongoose-custom-pagination demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Crates.io adds Trusted Publishing support, enabling secure GitHub Actions-based crate releases without long-lived API tokens.
Research
/Security News
Undocumented protestware found in 28 npm packages disrupts UI for Russian-language users visiting Russian and Belarusian domains.
Research
/Security News
North Korean threat actors deploy 67 malicious npm packages using the newly discovered XORIndex malware loader.