# nestjs-sequelize-pagination
> Pagination helper method for Sequelize models.
Latest version **2.0.1** (published 2024-06-02) · MIT license · 0 weekly downloads
## Install
```sh
npm install nestjs-sequelize-pagination
pnpm add nestjs-sequelize-pagination
yarn add nestjs-sequelize-pagination
bun add nestjs-sequelize-pagination
```
## Health
**Score 20/100 (F)** — status: abandoned.
Positive: has types; no vulnerabilities.
Warnings: low downloads; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.0.1 |
| Published | 2024-06-02 |
| First published | 2023-06-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 33.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Mahsum UREBE |
| Maintainers | mahsumurebe |
| Keywords | nestjs, pagination, sequelize |
## Links
- npm: https://www.npmjs.com/package/nestjs-sequelize-pagination
- Repository: https://github.com/mahsumurebe/nestjs-sequelize-pagination
- Homepage: https://github.com/mahsumurebe/nestjs-sequelize-pagination#readme
- Issues: https://github.com/mahsumurebe/nestjs-sequelize-pagination/issues
- npm.io page: https://npm.io/package/nestjs-sequelize-pagination
## Recent versions
- 2.0.1 (latest) — 2024-06-02
- 2.0.0 — 2024-06-02
- 1.4.1 — 2023-12-01
- 1.4.0 — 2023-06-20
- 1.2.11 — 2023-06-20
- 1.1.11 — 2023-06-20
- 1.1.1 — 2023-06-20
- 1.1.0 — 2023-06-20
- 1.0.0 — 2023-06-20
## README
# NestJs Sequelize Pagination
Sequelize pagination module for NestJS.
## Description
NestJS database connection must be established before using nestjs-sequelize-pagination. You can use the database module
for this. You can review the [sequelize](https://docs.nestjs.com/techniques/database#sequelize-integration) document.
## Integration
To start using it, we first install the required dependencies. In this chapter we will demonstrate the use of the
pagination for nestjs.
You simply need to install the package !
```shell
$ npm install --save nestjs-sequelize-pagination
```
## Getting Started
Once the installation process is complete, we can import the **PaginationModule** into the root **AppModule**
```ts
import { Module } from '@nestjs/common';
import { SequelizeModule } from '@nestjs/sequelize';
import { ItemsModule } from './items/items.module';
import { PaginationModule } from 'nestjs-sequelize-pagination';
import * as SQLite from 'sqlite3';
@Module({
imports: [
SequelizeModule.forRoot({
logging: false,
synchronize: true,
autoLoadModels: true,
retryAttempts: 2,
retryDelay: 1000,
dialect: 'sqlite',
storage: 'tests/db.sqlite',
dialectOptions: {
mode:
SQLite.OPEN_READWRITE | SQLite.OPEN_CREATE | SQLite.OPEN_FULLMUTEX,
},
}),
ItemsModule,
PaginationModule.forRoot({
isGlobal: true,
limit: 50,
page: 1,
withDetails: true,
url: 'http://localhost:3001/',
}),
],
})
export class AppModule {
}
```
The **forRoot()** method supports all the configuration properties exposed by the pagination constuctor . In addition,
there are several extra configuration properties described below.
| Name | Description | Type | Default |
|-------------|----------------------------------------------------------------------------------------------------------|---------------------------|-----------------|
| url | If you want a global url | _string_ | `null` |
| isGlobal | If you want the module globally | _boolean_ | `false` |
| page | It is used by default when page information is not sent. | _number_ | `1` |
| limit | It is used by default when limit information is not sent. | _number_ | `50` |
| withDetails | Used to detail meta information | 'necessary' \| 'complete' | `necessary` |
| cls | Paginated Data class to be used in function output. The class must be extended to PaginatedDataAbstract. | PaginatedDataAbstract | `PaginatedData` |
### Service
Sequelize implements the Active Record pattern. With this pattern, you use model classes directly to interact with the
database. To continue the example, we need at least one model. Let's define the Item Model.
```ts
import { Injectable } from '@nestjs/common'
import { PaginationService, PaginationOptions } from 'nestjs-sequelize-pagination'
import { FindAndCountOptions } from 'sequelize';
import { ItemEntity } from './item.entity'
@Injectable()
export class ItemService {
constructor(
private readonly paginationService: PaginationService,
@InjectModel(ItemEntity)
private readonly itemRepository: typeof ItemEntity,
) {
}
findAll(
options: PaginationOptions,
optionsSequelize: FindAndCountOptions = {},
) {
return this.paginationService.findAllPaginate(
this.itemRepository,
options,
optionsSequelize,
);
}
}
```
Next, let's look at the **ItemsController:**
```ts
import { Controller, Get, Res, HttpStatus } from '@nestjs/common'
import { ItemService } from './item.service'
import { PaginationOptions, PaginationQuery } from 'nestjs-sequelize-pagination'
@Controller('items')
export class ItemsController {
constructor(private readonly itemService: ItemService) {
}
@Get('/')
findAll(@PaginationQuery() paginateQuery: PaginationOptions) {
return this.itemService.findAll(paginateQuery);
}
}
```
Next, let's look at the **ItemsModule:**
```ts
import { Module } from '@nestjs/common';
import { SequelizeModule } from '@nestjs/sequelize';
import { ItemEntity } from './item.entity';
import { ItemController } from './item.controller';
import { ItemService } from './item.service';
@Module({
imports: [SequelizeModule.forFeature([ItemEntity])],
controllers: [ItemController],
providers: [ItemService],
})
export class ItemsModule {
}
```
### Decorator
PaginationQuery decorator extracts the page and limit value from the querystring. This decorator can only be used in
the http context.
```ts
import { PaginationOptions } from "nestjs-sequelize-pagination";
const paginateQuery: PaginationOptions = {
path: '/item',
page: 2, // http://localhost:3000/item?page=2
limit: 10, // http://localhost:3000/item?page=2&limit=10
}
```
## License
nestjs-sequelize-pagination is [MIT licensed](./LICENSE).
---
_Source: https://npm.io/package/nestjs-sequelize-pagination · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._