NestJS Paginate 项目教程

NestJS Paginate 项目教程

nestjs-paginatePagination and filtering helper method for TypeORM repositories or query builders using Nest.js framework :book::paperclip:项目地址:https://gitcode.com/gh_mirrors/ne/nestjs-paginate

1. 项目的目录结构及介绍

nestjs-paginate/
├── src/
│   ├── common/
│   │   ├── decorators/
│   │   │   └── api-paginated-response.decorator.ts
│   │   └── dtos/
│   │       └── page.dto.ts
│   ├── app/
│   │   ├── app.module.ts
│   │   └── app.controller.ts
│   ├── entities/
│   │   └── user.entity.ts
│   ├── main.ts
│   └── util/
│       └── swagger.ts
├── package.json
├── tsconfig.json
└── README.md

目录结构介绍

• src/: 项目源代码目录。
  • common/: 包含通用功能，如装饰器和数据传输对象（DTO）。
    • decorators/: 自定义装饰器，如 api-paginated-response.decorator.ts。
    • dtos/: 数据传输对象，如 page.dto.ts。
  • app/: 应用模块和控制器。
    • app.module.ts: 应用的主模块。
    • app.controller.ts: 应用的主控制器。
  • entities/: 数据库实体，如 user.entity.ts。
  • main.ts: 应用的启动文件。
  • util/: 工具函数，如 swagger.ts。
• package.json: 项目依赖和脚本配置。
• tsconfig.json: TypeScript 编译配置。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

main.ts

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app/app.module';
import { ValidationPipe } from '@nestjs/common';
import { setupSwagger } from './util/swagger';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.useGlobalPipes(new ValidationPipe({ transform: true }));
  setupSwagger(app);
  await app.listen(3000);
}
bootstrap();

启动文件介绍

• NestFactory.create(AppModule): 创建 NestJS 应用实例。
• app.useGlobalPipes(new ValidationPipe({ transform: true })): 全局启用验证管道，自动转换请求数据。
• setupSwagger(app): 设置 Swagger 文档。
• app.listen(3000): 启动应用并监听 3000 端口。

3. 项目的配置文件介绍

tsconfig.json

{
  "compilerOptions": {
    "module": "commonjs",
    "declaration": true,
    "removeComments": true,
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
    "allowSyntheticDefaultImports": true,
    "target": "es2017",
    "sourceMap": true,
    "outDir": "./dist",
    "baseUrl": "./",
    "incremental": true
  }
}

配置文件介绍

• compilerOptions: TypeScript 编译选项。
  • module: 指定模块系统为 commonjs。
  • declaration: 生成 .d.ts 声明文件。
  • removeComments: 移除注释。
  • emitDecoratorMetadata 和 experimentalDecorators: 启用装饰器元数据和实验性装饰器。
  • allowSyntheticDefaultImports: 允许合成默认导入。
  • target: 指定编译目标为 es2017。
  • sourceMap: 生成源映射文件。
  • outDir: 指定输出目录为 ./dist。
  • baseUrl: 指定基础路径为 ./。
  • incremental: 启用增量编译。

通过以上介绍，您可以更好地理解和使用 nestjs-paginate 项目。希望本教程对您有所帮助！

nestjs-paginatePagination and filtering helper method for TypeORM repositories or query builders using Nest.js framework :book::paperclip:项目地址:https://gitcode.com/gh_mirrors/ne/nestjs-paginate