# @types/mongoose-paginate

> TypeScript definitions for mongoose-paginate

Latest version **5.0.16** (published 2023-11-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/mongoose-paginate
pnpm add @types/mongoose-paginate
yarn add @types/mongoose-paginate
bun add @types/mongoose-paginate
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 5.0.16 |
| Published | 2023-11-21 |
| First published | 2016-08-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51440 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/mongoose-paginate
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mongoose-paginate
- npm.io page: https://npm.io/package/@types/mongoose-paginate

## Dependencies (2)

- [mongoose](https://npm.io/package/mongoose.md) ^6.3.0
- [@types/node](https://npm.io/package/@types/node.md) *

## Recent versions

- 5.0.16 (latest) — 2023-11-21
- 5.0.12 (ts4.1) — 2022-04-24
- 5.0.11 (ts3.8) — 2021-12-24
- 5.0.10 (ts3.6) — 2021-07-08
- 5.0.8 (ts3.0) — 2019-10-03
- 5.0.7 (ts2.8) — 2019-09-26
- 5.0.6 (ts2.3) — 2017-08-21
- 5.0.4 (ts2.0) — 2016-11-21
- 5.0.15 — 2023-11-07
- 5.0.14 — 2023-10-18
- 5.0.13 — 2023-09-27
- 5.0.9 — 2021-06-03
- 5.0.5 — 2017-06-07
- 5.0.3 — 2016-09-19
- 5.0.2 — 2016-08-25
- … 1 more at https://npm.io/package/@types/mongoose-paginate/versions

## README

# Installation
> `npm install --save @types/mongoose-paginate`

# Summary
This package contains type definitions for mongoose-paginate (https://github.com/edwardhotchkiss/mongoose-paginate).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mongoose-paginate.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mongoose-paginate/index.d.ts)
````ts
/// <reference types="mongoose" />

declare module "mongoose" {
    export interface PaginateOptions {
        select?: Object | string | undefined;
        sort?: Object | string | undefined;
        populate?:
            | Object[]
            | string[]
            | Object
            | string
            | QueryPopulateOptions
            | undefined;
        lean?: boolean | undefined;
        leanWithId?: boolean | undefined;
        offset?: number | undefined;
        page?: number | undefined;
        limit?: number | undefined;
    }

    interface QueryPopulateOptions {
        /** space delimited path(s) to populate */
        path: string;
        /** optional fields to select */
        select?: any;
        /** optional query conditions to match */
        match?: any;
        /** optional model to use for population */
        model?: string | Model<any> | undefined;
        /** optional query options like sort, limit, etc */
        options?: any;
        /** deep populate */
        populate?: QueryPopulateOptions | QueryPopulateOptions[] | undefined;
    }

    export interface PaginateResult<T> {
        docs: T[];
        total: number;
        limit: number;
        page?: number | undefined;
        pages?: number | undefined;
        offset?: number | undefined;
    }

    interface PaginateModel<T extends Document> extends Model<T> {
        paginate(
            query?: Object,
            options?: PaginateOptions,
            callback?: (err: any, result: PaginateResult<T>) => void,
        ): Promise<PaginateResult<T>>;
    }

    export function model<T extends Document>(
        name: string,
        schema?: Schema,
        collection?: string,
        skipInit?: boolean,
    ): PaginateModel<T>;

    export function model<T extends Document, U extends PaginateModel<T>>(
        name: string,
        schema?: Schema,
        collection?: string,
        skipInit?: boolean,
    ): U;
}

declare module "mongoose-paginate" {
    import mongoose = require("mongoose");
    var _: (schema: mongoose.Schema) => void;
    export = _;
}

````

### Additional Details
 * Last updated: Mon, 20 Nov 2023 23:36:24 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node), [mongoose](https://npmjs.com/package/mongoose)

# Credits
These definitions were written by [Linus Brolin](https://github.com/linusbrolin).

---
_Source: https://npm.io/package/@types/mongoose-paginate · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._