{"id":15190579,"url":"https://github.com/3zrv/mongoose-simple-pager","last_synced_at":"2026-03-02T20:34:07.805Z","repository":{"id":65163725,"uuid":"584372415","full_name":"3zrv/mongoose-simple-pager","owner":"3zrv","description":"Lightweight pagination plugin for mongoose","archived":false,"fork":false,"pushed_at":"2023-05-13T15:51:12.000Z","size":703,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-16T15:50:53.502Z","etag":null,"topics":["mongoose","mongoose-paginate","mongoose-plugin","nodejs"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/mongoose-simple-pager","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/3zrv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-02T11:34:34.000Z","updated_at":"2023-01-07T13:38:18.000Z","dependencies_parsed_at":"2024-09-11T11:53:01.278Z","dependency_job_id":null,"html_url":"https://github.com/3zrv/mongoose-simple-pager","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3zrv%2Fmongoose-simple-pager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3zrv%2Fmongoose-simple-pager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3zrv%2Fmongoose-simple-pager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3zrv%2Fmongoose-simple-pager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/3zrv","download_url":"https://codeload.github.com/3zrv/mongoose-simple-pager/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241061922,"owners_count":19902793,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mongoose","mongoose-paginate","mongoose-plugin","nodejs"],"created_at":"2024-09-27T20:42:31.141Z","updated_at":"2026-03-02T20:34:02.778Z","avatar_url":"https://github.com/3zrv.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![npm version](https://badge.fury.io/js/mongoose-simple-pager.png)](https://badge.fury.io/js/mongoose-simple-pager)\n[![Coverage Status](https://coveralls.io/repos/github/3zrv/mongoose-simple-pager/badge.svg?branch=master)](https://coveralls.io/github/3zrv/mongoose-simple-pager?branch=master)\n![CI](https://img.shields.io/github/actions/workflow/status/0x3zra/mongoose-simple-pager/node.js.yml)\n# mongoose-simple-pager\n\nPagination plugin for [mongoose.js](http://mongoosejs.com/).\n\n## Requirements\n\n- [NodeJS](https://nodejs.org/en/) \u003e= 6.0\n\n## Installation\n\n```bash\n$ npm install mongoose-simple-pager\n```\n\n## Example usage\n\n```javascript\n// userModel.js\nimport mongoose from \"mongoose\";\nimport paginate from \"mongoose-simple-pager\";\n\nconst userSchema = mongoose.Schema({\n  firstName: {\n    type: String,\n    required: true,\n  },\n  lastName: {\n    type: String,\n    required: true,\n  },\n  userName: {\n    type: String,\n    required: true,\n    unique: true,\n  },\n  roles: [\n    {\n      type: mongoose.SchemaTypes.ObjectId,\n      ref: \"roles\",\n    },\n  ],\n});\n\nuserSchema.plugin(paginate);\n```\n\n```js\n// controller.js\nconst User = mongoose.model(\"userModel\");\n\nconst options = {\n  limit: 5,\n  page: 1,\n};\n\nreturn await User.paginate(options);\n```\n\n### Output will be:\n\n```json\n{\n  \"data\": [\n    {\n      \"obj1\": {...}\n    },\n    {\n      \"obj2\": {...}\n    },\n    {\n      \"obj3\": {...}\n    },\n    {\n      \"obj4\": {...}\n    },\n    {\n      \"obj5\": {...}\n    }\n  ],\n  \"pagination\": {\n    \"total\": 123\n  }\n}\n```\n\n### Adding a query and populate options\n\n```javascript\nconst User = mongoose.model(\"userModel\");\n\nconst options = {\n  limit: 5,\n  page: 1,\n};\n\nconst query = {\n  $or: [\n    {\n      userName: {\n        $regex: \"x\",\n        $options: \"i\",\n      },\n    },\n  ],\n};\n\nreturn await User.paginate(options, \"roles\", query);\n```\n\n## Todo\n* Accept aggregate queries\n* Migrate to typescript\n\n## Contributing\n\n1. Fork it ( https://github.com/0x3zra/mongoose-simple-pager/fork )\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n## License\n\nThe MIT License (MIT)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3zrv%2Fmongoose-simple-pager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F3zrv%2Fmongoose-simple-pager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3zrv%2Fmongoose-simple-pager/lists"}