npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mongoose-cursor-paginate

v1.0.1

Published

cursor based mongoose pagination

Downloads

2

Readme

mongoose-cursor-paginate

This module is been developed to provide mongoose support for mongo-cursor-pagination. Please read this blog post to get clear understanding on cursor based pagination.

Installation

npm install mongoose-cursor-paginate --save

Usage

Define your mongoose schema and plug the mongoose-cursor-paginate module.

const paginate = require('mongoose-cursor-paginate');

const PostSchema = new mongoose.Schema({
  title: String,
  date: Date,
  body : String,
  author: {
    type: mongoose.Schema.ObjectId,
    ref: 'Author'
  }
});

PostSchema.plugin(mongooseCursorPaginate);

const Post = mongoose.model('Post', PostSchema); // Post.paginate()

Model.paginate([params])

Parameters

  • [params] {Object}

    • [query] {Object} - Query criteria. Documentation

    • [limit] {Number} - The page size.

    • [fields] {Object} - Fields to query in the Mongo object format, e.g. {_id: 1, timestamp :1} . The default is to query all fields.

    • [paginatedField] {String} - The field name to query the range for. The field must be:

      1. Orderable. We must sort by this value. If duplicate values for paginatedField field exist, the results will be secondarily ordered by the _id.
      2. Indexed. For large collections, this should be indexed for query performance.
      3. Immutable. If the value changes between paged queries, it could appear twice.

      The default is to use the Mongo built-in '_id' field, which satisfies the above criteria.

      The only reason to NOT use the Mongo _id field is if you chose to implement your own ids.

    • [next] {String} - The value to start querying the page.

    • [previous] {String} - The value to start querying previous page.

    • [sortAscending] {Boolean} - The value to sort data in asc

Return value

Promise fulfilled with object having properties:

  • results {Array} - Array of documents
  • previous {String} - previous id.
  • hasPrevious {Boolean} - will be true only if previous data exist.
  • next {String} - next id.
  • hasNext {Boolean} - will be true only if next data exist.

Examples

Post.paginate({
  query : {  title : { $regex : new RegExp('^Post.*$') } },
  limit : 10,
  fields : { author : 1 },
  paginatedField : 'date',
})
.then((result) => {
 ...
})

Tests

npm install
npm run test