A custom pagination library for Mongoose with customizable labels. 

aravindnc

mongoose-paginate-v2

Error

Ignore

Warn

License

Maintenance

Miscellaneous

Quality

Supply chain risk

Vulnerability

Admins only

Organization members

Dashboard

<upgradeLink>Upgrade</upgradeLink> to access this feature

About

Blog

Socket CLI

Customers

Socket Dependency Search

Docs

Socket for GitHub

Love

Impersonation Mode Active

Update your browser to the latest version for the best experience.

Your web browser is outdated

Use another browser for the best experience.

Your web browser is unsupported

{{count, number}} commits last two months

{{count, number}} critical severity alert

{{count, number}} critical severity alerts

{{count, number}} dependency vulnerability

{{count, number}} dependency vulnerabilities

{{count, number}} development dependencies

{{count, number}} transitive dependencies

{{count, number}} version published last month

{{count, number}} versions published last month

{{count, number}} version published in last two months

{{count, number}} versions published in last two months

{{count, number}} version published last week

{{count, number}} versions published last week

{{count, number}} version published last year

{{count, number}} versions published last year

Socket undergoes annual SOC2 Type II audits. Socket customers can request a copy of the full SOC2 Type II report.

Allows organization owners and admins to access detailed records of actions taken by members of their organization, complete with timestamps.

Prevent compromised packages from infiltrating your supply chain by monitoring for changes in real-time.

Join our Discord community to get help from Socket engineers and other Socket users.

Compare millions of open source packages on socket.dev

Detect malicious code and risky behavior (e.g. network) in your dependencies using "deep package inspection"

All data is encrypted in transit and at rest using industry standard encryption algorithms.

Get a dedicated Socket account manager and access to Socket’s Customer Success team.

Get dedicated support from Socket engineers via email and Slack.

"Shift left" with the Socket Chrome extension and give intervene early, before developers choose risky or low quality dependencies.

Catch developers using risky dependencies and give them a "speed bump" to encourage good behavior

Install the Socket GitHub app to receive real-time dependency scanning and reports with every pull request.

Integrate Socket into your GitHub SCM to prevent risky dependencies from being installed.

Socket scans for vulnerabilities in your dependencies, including CVEs, security advisories, and more.

Socket supports dependencies in many languages, with most popular ecosystems coming in 2024. We've got you covered no matter what languages you use.

Enforce license policies across your organization

Receive a Microsoft Teams message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Get help migrating from Socket's free plan to Socket's paid plans.

Run Socket on-premises or in your own cloud environment.

Query for any dependency (at any version) across your entire organization

Integrate Socket into your CI/CD pipeline to prevent risky dependencies from being deployed to production.

Analyze an entire project to find supply chain risks

Tag projects to organize and filter your projects

Restrict access based on the roles of individual users within an organization.

Receive a Slack message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket is SOC2 Type II compliant and undergoes annual audits.

The Socket CLI allows teams to prevent risky dependencies from being installed, and to get dependency insights from the command line.

Socket supports SAML SSO for single sign-on and identity management.

Integrate Socket into your VS Code IDE to prevent risky dependencies from being installed.

Get a POST request anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket will analyzed your SBOMs up to a maximum number of dependencies.

API that allows you to analyze a project, lookup package scores and alerts, and more.

Create API tokens to authenticate with the Socket API and CLI.

The number of developers in your team. A developer is someone who made a commit to your organization's repositories scanned by Socket in the past month.

Use Socket to protect your private repositories.

Socket is always free for open source projects.

Socket retains all reporting data for 3 months, 1 year, or a custom term of your choice.

Access the threat feed that powers Socket.

Unlimited scale, self-hosting, and priority support for large teams.

For open-source projects, individuals, and small teams.

For growing teams with enhanced scale, security, and support.

There is a package with a similar name that is downloaded much more often.

There are packages with similar names that are downloaded much more often.

This may not be the package you want!

Instance

Alert Locations

Package

The {{ecosystem}} package {{- packageName}} receives a total of <strong>{{numWeeklyDownloadCount, number}}</strong> weekly downloads. As such, {{- packageName}} popularity was classified as <strong>{{popularity}}</strong>.

Is {{- packageName}} popular?

Is {{- packageName}} safe to use?

Is {{- packageName}} well maintained?

What is {{- packageName}}?

{{packageDescription}}Version: {{versionString}} was published by {{publisherName}}. Start using Socket to analyze {{- packageName}} and its {{dependencyCount, number}} dependencies to secure your app from supply chain attacks.

Sorry, it seems this package was removed from the registry

Package was removed

This package version has been unpublished, mostly likely due to security reasons

Package version was removed

Provide a detailed description of the malware...

Socket fights vulnerabilities and provides visibility, defense-in-depth, and proactive supply chain protection for JavaScript, Python, and Go dependencies.

Socket - Secure your dependencies. Ship with confidence.

Compare versions

{{- packageName}} - npm Package Compare versions

- Removed 2D test cases to support Mongoose 6.

- Fix: update paginate options typings #154, #156

- Added feature: PaginationParameters helper class

- Fix hasPrevPage behaviour with limit > offset > 0

- Removed 'cursor' text across the project.

- Removed test case for allowDiskUse, which cause build to fail on lower MongoDB versions.

- Added allowDiskUse option as a workaround for QueryExceededMemoryLimitNoDiskUseAllowed error with large data sets.

- Collation fix for MongoDB v3.4 and less.

- Fixed issues where no results or incorrect count are returned when using collations.

- Fixed issue hasPrevPage and prevPage returned values are not correct at page=1 (#119)

  interface CustomLabels<T = string | undefined | boolean> {

    select?: object | string | undefined;

    collation?: import('mongodb').CollationDocument | undefined;

    collation?: import('mongodb').CollationOptions | undefined;

    customLabels?: CustomLabels | undefined;

    /* If pagination is set to `false`, it will return all docs without adding limit condition. (Default: `true`) */

    useEstimatedCount?: boolean | undefined;

    useCustomCountFn?: (() => Promise<number>) | undefined;

    prevPage?: number | null | undefined;

    nextPage?: number | null | undefined;

    [customLabel: string]: T[] | number | boolean | null | undefined;

    : HydratedDocument<T, TMethods, TVirtuals>;

  interface PaginateModel<T, TQueryHelpers = {}, TMethods = {}>

    extends Model<T, TQueryHelpers, TMethods> {

        result: PaginateResult<PaginateDocument<T, TMethods, O>>

    ): Promise<PaginateResult<PaginateDocument<T, TMethods, O>>>;

declare function _(schema: mongoose.Schema): void;

  const paginate: { options: mongoose.PaginateOptions };

  class PaginationParameters<T, O extends mongoose.PaginateOptions> {

    constructor(request: { query?: Record<string, any> });

    getQuery: () => mongoose.FilterQuery<T>;

    get: () => [mongoose.FilterQuery<T>, O];

  "description": "A custom pagination library for Mongoose with customizable labels.",

    "test": "./node_modules/.bin/mocha tests/*.js -R spec --ui bdd --timeout 9999999",

    "lint": "./node_modules/.bin/eslint \"tests\" \"src\" \".eslintrc.js\" --fix",

    "prettier": "./node_modules/.bin/prettier --write \"{src,tests}/**/*.js\" \"*.md\"",

      "pre-commit": "./node_modules/.bin/lint-staged"

      "./node_modules/.bin/eslint --fix",

      "./node_modules/.bin/prettier --write"

    "url": "git+https://github.com/aravindnc/mongoose-paginate-v2.git"

  "author": "Aravind NC <aravind_n_c@yahoo.co.in> (https://aravindnc.com)",

    "Fernando López Guevara (fernando.lguevara@gmail.com)"

    "url": "https://github.com/aravindnc/mongoose-paginate-v2/issues"

  "homepage": "https://github.com/aravindnc/mongoose-paginate-v2#readme",

    "@babel/plugin-proposal-class-properties": "^7.14.5",

    "@babel/plugin-proposal-decorators": "^7.14.5",

    "@babel/plugin-proposal-do-expressions": "^7.14.5",

    "@babel/plugin-proposal-export-default-from": "^7.14.5",

    "@babel/plugin-proposal-export-namespace-from": "^7.14.5",

    "@babel/plugin-proposal-function-bind": "^7.14.5",

    "@babel/plugin-proposal-function-sent": "^7.14.5",

    "@babel/plugin-proposal-json-strings": "^7.14.5",

    "@babel/plugin-proposal-logical-assignment-operators": "^7.14.5",

    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.14.5",

    "@babel/plugin-proposal-numeric-separator": "^7.14.5",

    "@babel/plugin-proposal-optional-chaining": "^7.14.5",

    "@babel/plugin-proposal-pipeline-operator": "^7.14.5",

    "@babel/plugin-proposal-throw-expressions": "^7.14.5",

    "@babel/plugin-syntax-dynamic-import": "^7.8.3",

    "@babel/plugin-syntax-import-meta": "^7.10.4",

    "@typescript-eslint/eslint-plugin": "^5.10.2",

    "@typescript-eslint/parser": "^5.10.2",

[![npm version](https://img.shields.io/npm/v/mongoose-paginate-v2.svg)](https://www.npmjs.com/package/mongoose-paginate-v2)

[![Build Status](https://travis-ci.com/aravindnc/mongoose-paginate-v2.svg?branch=master)](https://travis-ci.com/aravindnc/mongoose-paginate-v2)

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/aravindnc/mongoose-paginate-v2/issues)

[![Downloads](https://img.shields.io/npm/dm/mongoose-paginate-v2.svg)](https://img.shields.io/npm/dm/mongoose-paginate-v2.svg)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Faravindnc%2Fmongoose-paginate-v2.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Faravindnc%2Fmongoose-paginate-v2?ref=badge_shield)

> A custom pagination library for [Mongoose](http://mongoosejs.com) with customizable labels.

If you are looking for aggregate query pagination, use this one [mongoose-aggregate-paginate-v2](https://github.com/aravindnc/mongoose-aggregate-paginate-v2)

[![NPM](https://nodei.co/npm/mongoose-paginate-v2.png?downloads=true&downloadRank=true&stars=true)](https://www.npmjs.com/package/mongoose-paginate-v2)

mongoose-paginate-v2 is a pagination library having a page wrapper. The main usage of the plugin is you can alter the return value keys directly in the query itself so that you don't need any extra code for transformation. The initial idea of this plugin is loosely based on mongoose-paginate package by github.com/edwardhotchkiss/. So this can be considered as an upgraded version of mongoose-paginate with much more options.

The below documentation is not perfect. Feel free to contribute. :)

Add plugin to a schema and then use model `paginate` method:

const mongoosePaginate = require('mongoose-paginate-v2');

const myModel = mongoose.model('SampleModel', mySchema);

Prior to version `1.5.0`, types need to be installed from [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mongoose-paginate-v2).

To declare a `PaginateModel` in your Typescript files:

import paginate from 'mongoose-paginate-v2';

export const institutionSchema = new Schema({ name: String });

// declare a mongoose document based on a Typescript interface representing your schema

interface InstitutionDocument extends Document, InstitutionData {}

>('Institutions', institutionSchema, 'institutions');

### Model.paginate([query], [options], [callback])

- `[query]` {Object} - Query criteria. [Documentation](https://docs.mongodb.org/manual/tutorial/query-documents)

  - `[select]` {Object | String} - Fields to return (by default returns all fields). [Documentation](http://mongoosejs.com/docs/api.html#query_Query-select)

  - `[collation]` {Object} - Specify the collation [Documentation](https://docs.mongodb.com/manual/reference/collation/)

  - `[sort]` {Object | String} - Sort order. [Documentation](http://mongoosejs.com/docs/api.html#query_Query-sort)

  - `[populate]` {Array | Object | String} - Paths which should be populated with other documents. [Documentation](http://mongoosejs.com/docs/api.html#query_Query-populate)

  - `[projection]` {String | Object} - Get/set the query projection. [Documentation](https://mongoosejs.com/docs/api/query.html#query_Query-projection)

  - `[lean=false]` {Boolean} - Should return plain javascript objects instead of Mongoose documents? [Documentation](http://mongoosejs.com/docs/api.html#query_Query-lean)

  - `[leanWithId=true]` {Boolean} - If `lean` and `leanWithId` are `true`, adds `id` field with string representation of `_id` to every document

  - `[offset=0]` {Number} - Use `offset` or `page` to set skip position

  - `[customLabels]` {Object} - Developers can provide custom labels for manipulating the response data.

  - `[pagination]` {Boolean} - If `pagination` is set to false, it will return all docs without adding limit condition. (Default: True)

		# Changelog

		## v1.6.3

		[2022-02-28]

		- Added support for Mongoose 6

		## v1.6.2
		@@ -4,0 +10,0 @@

		@@ -23,3 +23,3 @@ declare module 'mongoose' {
		select?: object \| string \| undefined;
		collation?: import('mongodb').CollationDocument \| undefined;
		collation?: import('mongodb').CollationOptions \| undefined;
		sort?: object \| string \| undefined;
		@@ -69,2 +69,3 @@ populate?:
		TMethods,
		TVirtuals,
		O extends PaginateOptions = {}
		@@ -75,3 +76,3 @@ > = O['lean'] extends true
		: LeanDocument<T>
		: EnforceDocument<T, TMethods>;
		: HydratedDocument<T, TMethods, TVirtuals>;

		@@ -78,0 +79,0 @@ interface PaginateModel<T, TQueryHelpers = {}, TMethods = {}>

		{
		"name": "mongoose-paginate-v2",
		"version": "1.6.2",
		"version": "1.6.3",
		"description": "A custom pagination library for Mongoose with customizable labels.",
		@@ -5,0 +5,0 @@ "main": "dist/index.js",

		@@ -414,3 +414,3 @@ ![Banner](static/banner.jpg)

		$geoNear, $near, and $nearSphere will not work. This will be updated in the future plugin versions.
		$geoNear, $near, and $nearSphere may not work (Untested). This will be updated in the future plugin versions.

		@@ -431,3 +431,1 @@ ## Development
		[MIT](LICENSE)

		[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Faravindnc%2Fmongoose-paginate-v2.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Faravindnc%2Fmongoose-paginate-v2?ref=badge_large)

Improved metrics

Worsened metrics