https://github.com/mother/mongoose-cursor-pagination

Easy-to-use, scalable, cursor pagination plugin for mongoose
https://github.com/mother/mongoose-cursor-pagination

cursor mongodb mongoose pagination

Last synced: 2 months ago
JSON representation

Easy-to-use, scalable, cursor pagination plugin for mongoose

• Host: GitHub
• URL: https://github.com/mother/mongoose-cursor-pagination
• Owner: mother
• License: mit
• Created: 2019-02-14T06:57:56.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-07-18T21:25:50.000Z (over 1 year ago)
• Last Synced: 2024-10-02T02:41:34.516Z (3 months ago)
• Topics: cursor, mongodb, mongoose, pagination
• Language: JavaScript
• Size: 1.04 MB
• Stars: 5
• Watchers: 4
• Forks: 2
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: History.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mongoose-cursor-pagination

[![Build Status](https://travis-ci.org/mother/mongoose-cursor-pagination.svg?branch=master)](https://travis-ci.org/mother/mongoose-cursor-pagination)

This small plugin makes it easy to use cursor-based pagination in your app, without changing the way you use queries in mongoose.

## Installation

```npm install @mother/mongoose-cursor-pagination --save```

Node.js 10.x or higher is required.

## Usage

In your schema:

```javascript

import mongoose from 'mongoose'

import paginationPlugin from '@mother/mongoose-cursor-pagination'

const CommentSchema = new mongoose.Schema({

  date: { type: Date },

  body: { type: String },

  author: {

     firstName: { type: String },

     lastName: { type: String }

  }

})

CommentSchema.plugin(paginationPlugin)

```

In your application code:

```javascript

const { results, pageInfo } = await Comment

   .find({})                 // Whatever filter you want

   .limit(30)                // Use limit and other Query options as you normally would

   .sort('author.lastName')  // Use sort as you would normally do

   .paginate(startCursor)    // startCursor optional

   .exec()                   // Required

```

`results` will be the results that you would expect from a normal mongoose `find` query

`pageInfo` will have two properties: `hasNext` and `nextCursor`

Be sure to index correctly. Note that this plugin always add `_id` to the sort key to ensure cursors are unique, so include that in your index as well. For example, say you are using the `date` field for pagination, then you would want to setup the index:

```js

commentSchema.index({ date: -1, _id: -1 })

```

## Plugin Options

You can optionally pass an options object to this plugin:

```js

CommentSchema.plugin(paginationPlugin, {

   // If no limit is specified, and paginate() is being used,

   // what should the default limit be.

   defaultLimit: 100

})

```

## Tests

Numerous tests are included in the `tests` directory, and can be run using the command `npm test`.

## To Do

- Test against older versions of mongoose

- Support for search with pagination

- Support for aggregation with pagination

- Support for `hasPrev` and `prevCursor`

- Support `exec` calls that use callbacks instead of promises

## License

MIT