# @frabbit/mongoose-paginate 中文文档

规范地址：https://npmcn.com/package/%40frabbit/mongoose-paginate/

版本：7\.2\.6
npm 元数据更新时间：2023-10-24T07:54:41.127Z
中文译文更新时间：2026-11-15T11:24:13.239Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40frabbit/mongoose-paginate
原文对照：https://npmcn.com/package/%40frabbit/mongoose-paginate/?lang=original
项目主页：https://github.com/frenchrabbit/mongoose-paginate#readme
源码仓库：https://github.com/frenchrabbit/mongoose-paginate

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：20.4 kB，7 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=16\.14\.0
- 运行依赖：0 个
- 首次发布：2023-10-18T08:12:17.009Z
- 最新版本发布：2023-10-24T07:54:40.960Z
- 近 30 天下载量：2064（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 0 个）

## 中文简介

Mongoose paginate 插件,其中包含完整的打字支持和对最新的mongoose包和类型的支持.

## 安装

```sh
npm install @frabbit/mongoose-paginate
```

也可以使用：`pnpm add @frabbit/mongoose-paginate`、`yarn add @frabbit/mongoose-paginate`、`bun add @frabbit/mongoose-paginate`

## README

# @ frabbit/ mongoose- 贴纸 [![npm](https://img.shields.io/npm/v/@frabbit/mongoose-paginate.svg)](https://npmjs.com/package/@frabbit/mongoose-paginate)

Mongoose paginate 插件,其中包含完整的打字支持和对最新的mongoose包和类型的支持.

主要想法是将页码选项添加到 `find()` 财务报告和审定财务报表 `aggregate()` 而不重复其他参数. Mongoose似乎在添加更多的打字支持,所以旧的pagination插件会变老.

## 特征

主要版本与梦雁版本相同

提供两种新型方法

```typescript
async function findPaginated(
  filter: FilterQuery<T> = {}, // same as  mongoose.find 
  pagination: PaginationOptions<T>, // plugin's param
  projection?: ProjectionType<T> | null, // same as  mongoose.find
  options?: QueryOptions<T> | null // same as  mongoose.find
): Promise<PaginatedResult<T>> {
}
```

```typescript
async function aggregatePaginated(
  pipeline: PipelineStage[], // same as mongoose.aggregate
  paginate: PaginationOptions<T>, // plugin's param
  options?: AggregateOptions // same as mongoose.aggregate
): Promise<PaginatedResult<T>> {
}
```

结果是:

```typescript
export class PaginatedResult<T> {
  /**
   * Documents on page
   */
  items: T[] = []

  /**
   * total documents count
   */
  total: number = 0

  /**
   * page
   */
  page: number = 1
  /**
   * total pages count
   */
  totalPages?: number = undefined

  /**
   * items per page
   */
  limit?: number = undefined

  /**
   * has previous page
   */
  hasPrevPage?: Boolean = false
  /**
   * has next page
   */
  hasNextPage?: Boolean = false

  /**
   * previous page number
   */
  prevPage?: number = undefined
  /**
   * next page number
   */
  nextPage?: number = undefined

  /**
   * The starting index/serial/chronological number of first document in current page.
   * (Eg: if page=2 and limit=10, then pagingCounter will be 11)
   */
  pagingCounter?: number = undefined

}
```

## 安装

```bash
npm i -D @frabbit/mongoose-paginate
```

## 使用量

```typescript
import {mongoosePaginate, PaginatedModel, PaginatedResult} from "@frabbit/mongoose-paginate";

interface Some {
  field: string
}

type SomeDocument = Document & Some

const someSchema = new Schema({
  field: String,
});

someSchema.plugin(mongoosePaginate);

const someModel: PaginatedModel<SomeDocument>
("Some", someSchema);

const items: PaginatedResult<SomeDocument> = await someModel.findPaginated({}, {limit: 10, page: 1})
const items2: PaginatedResult<Some> = await someModel.findPaginated({}, {limit: 10, page: 1}, {field: 1}, {lean: true})

```

## 许可证

[麻省理工学院](https://npmcn.com/package/%40frabbit/mongoose-paginate/LICENSE) 许可证 2023-Present [法国兔子](https://github.com/frenchrabbit)

## 常见问题

### @frabbit/mongoose-paginate 是什么？

Mongoose paginate 插件,其中包含完整的打字支持和对最新的mongoose包和类型的支持\.

### 如何安装 @frabbit/mongoose-paginate？

在项目目录运行 npm install @frabbit/mongoose-paginate，或使用 pnpm add / yarn add / bun add。

### @frabbit/mongoose-paginate 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @frabbit/mongoose-paginate 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @frabbit/mongoose-paginate 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=16\.14\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @frabbit/mongoose-paginate 可以商用吗？

@frabbit/mongoose-paginate 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @frabbit/mongoose-paginate 的下载量有多少？

根据 npm 官方下载统计，@frabbit/mongoose-paginate 在 2026/10/16 – 2026/11/14 这 30 天内被下载 2,064 次，日均约 69 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @frabbit/mongoose-paginate 还在维护吗？

最新版本 7\.2\.6 发布于 2023/10/24（3 年前）；至今共发布 11 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/10/18。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。