0.0.4 • Published 6 years ago
cursor-mongoose-pagination v0.0.4
cursor-mongoose-pagination
Cursor based pagination library for mongo using mongoose.
Installation
npm install cursor-mongoose-pagination
Usage
const mongoose = require('mongoose'),
cmp = require('cursor-mongoose-pagination')
const FooSchema = mongoose.Schema({
name: String,
age: Number
},{
timestamps:true
})
const FooModel = mongoose.model('Foo', FooSchema)
const params = {
find:{
// your find params, can be left blank if all the documents are wanted
}
limit:5, // the limit of documents you want at a time
next: cursor // only when calling for subsequent documents
//you can find this in the response array from the function
}
cmp.paginate(FooModel, params)
.then(result=>{
const docs = result[0], // the returned documents from the model
hasMore = result[1], // boolean value which tells if there are more documents left
next = result[2] // the cursor to the next document, this is null if hasMore is false
// should be passed in the function above
})
Currently this library only supports sorting based upon the updatedAt value of the document.
Continously making changes, and looking for suggestions.