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-pagination

v1.0.1

Published

Mongoose cursor-based pagination.

Downloads

226

Readme

mongoose-cursor-pagination

Build Status npm version Dependency Status devDependency Status contributions welcome HitCount

Mongoose cursor-based pagination

Installation

npm install mongoose-cursor-pagination --save

Usage

The plugin utilises cursor-based pagination via the startingAfter and endingBefore parameters. Both take an existing value (see below) and return objects in reverse chronological order. The endingBefore parameter returns objects listed before the named object. The startingAfter parameter returns objects listed after the named object. If both parameters are provided, only endingBefore is used. Moreover, an optional limit parameter can be passed to limit the amount of objects returned.

Add the plugin to a schema:

import mongoose from 'mongoose'
import paginationPlugin from 'mongoose-cursor-pagination'

const AccountSchema = new mongoose.Schema({
  username: { type: Number, unique: true, index: true }
})

AccountSchema.plugin(paginationPlugin)

mongoose.model('Account', AccountSchema)

and then use the model paginate method using a promise:

mongoose.model('Account').paginate({}, {
  sort: { '_id': 1 },
  startingAfter: '59b1f7fd41cfc303859ea1c9',
  limit: 20
})
  .then(results => { /* ... */ })
  .catch(error => { /* ... */ })

or using a callback:

mongoose.model('Account').paginate({}, {
  sort: { '_id': 1 }
}, (error, results) => {
  /* ... */
})

A possible value for results is:

{
  items: [ /* ... */ ],
  hasMore: true
}

where items is an array containing the elements, and hasMore is true if there are more elements available after this set. Or false otherwise.

The default plugin values can be overwritten, here we show the default values:

AccountSchema.plugin(paginationPlugin, {
  key: '_id',
  limit: 20,
  maxLimit: 100,
  minLimit: 1
})

The key specified is assumed to be unique and should have an index associated. Moreover, when paginating the key should be sorted ascending order and the values of startingAfter and endingBefore should contained values for that key.

Tests

npm install
npm test

License

MIT