GraphQL Mongoose Pagination

• GraphQL Mongoose Pagination
  • Why This Plugin
  • Install
  • Usage
    • Sample Usage
      • Model User
      • Example 1 : Get list User, don't used cursor
      • Example 2: Get list User, used cursor
    • Parameters in Pagination
    • Return value
      • Example

Why This Plugin

There are many libraries can do the same function. However, still not support filter containing condition $or and multiple cursor

Install

1npm install graphql-mongoose-pagination

Usage

Please see the following examples support with Graphql and Simple

Sample Usage

Given the following query

Model User

1const mongoose = require('mongoose');
2
3const { Schema } = mongoose;
4
5const UserSchema = new Schema({
6  email: String,
7  firstName: String,
8  lastName: String,
9  photo: String,
10  dateOfBirth: { type: Date, index: -1 },
11  activity: { type: Number, index: -1 },
12}, {
13  timestamps: true,
14});
15
16module.exports = mongoose.model('user', UserSchema);
17

Because sortFields only support the schema type ID,Number,Date therefore only one of the following 3 fields _id,dateOfBirth,activity

Example 1 : Get list User, don't used cursor

1const Pagination = require('graphql-mongoose-pagination')
2
3
4const paginated = new Pagination(
5  User,
6   {
7      criteria,
8      sort: { order: "desc"},
9      pagination: { limit:10 , skip: 100},
10      select,
11    },
12  );
13

Example 2: Get list User, used cursor

1const Pagination = require('graphql-mongoose-pagination')
2
3const {cursor } = input
4
5const paginated = new Pagination(
6  User,
7   {
8      criteria,
9      sort: { field: "dateOfBirth", order: "desc"},
10      pagination: { limit:10, cursor },
11      select,
12    },
13  );
14

Parameters in Pagination

• [criteria] {Object} - The filter of model
• [pagination] {Object}
  • [limit] { Number}: Limit that was used
  • [cursor] { String}: The cursor used compare with record
  • [skip] { Number}: The number skip record
• [sort] {Object}:
  • [order][Object] : Sort order only support asc|desc. Documentation
  • [fields][String] : Sort field with schema type ID,Number,Date
• [select] {String || Array} : Fields to return (by default returns all fields). Documentation

Return value

• [getDocs] {Promise} - Array of documents
• [getCursor] {String} - The cursor to used query next page

Example

1const Pagination = require('graphql-mongoose-pagination')
2
3const {cursor } = input
4
5const paginated = new Pagination(
6  User,
7   {
8      criteria,
9      sort: { field: "_id", order: "asc"},
10      pagination: { limit:10, cursor },
11      select,
12    },
13  );
14
15  // get list data
16await paginated.getDocs();
17
18//  Get cursor
19paginated.getCursor()
20