# nestjs-typeorm-paginate-aygiz
> A simple pagination function to build a pagination object with types
Latest version **2.2.1** (published 2020-08-31) · 0 weekly downloads
## Install
```sh
npm install nestjs-typeorm-paginate-aygiz
pnpm add nestjs-typeorm-paginate-aygiz
yarn add nestjs-typeorm-paginate-aygiz
bun add nestjs-typeorm-paginate-aygiz
```
## Health
**Score 30/100 (F)** — status: abandoned.
Positive: no vulnerabilities; high maintenance score.
Warnings: low downloads; no types; no esm support.
Negative: abandoned.
## Facts
| | |
|---|---|
| Version | 2.2.1 |
| Published | 2020-08-31 |
| First published | 2020-08-28 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 30.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 876 |
| Author | Ashleigh Simonelli |
| Maintainers | aygiz_saitgalin |
| Keywords | nestjs, typeorm, pagination, paginate |
## Links
- npm: https://www.npmjs.com/package/nestjs-typeorm-paginate-aygiz
- Repository: https://github.com/nestjsx/nestjs-typeorm-paginate
- Homepage: https://github.com/nestjsx/nestjs-typeorm-paginate#readme
- Issues: https://github.com/nestjsx/nestjs-typeorm-paginate/issues
- npm.io page: https://npm.io/package/nestjs-typeorm-paginate-aygiz
## Alternatives
- [@libsql/sqlite3](https://npm.io/package/@libsql/sqlite3.md) — 39.8K weekly downloads
- [@fortemi/core](https://npm.io/package/@fortemi/core.md) — 461 weekly downloads
- [cdb-converter](https://npm.io/package/cdb-converter.md) — 341 weekly downloads
- [@uplo/adapter-prisma](https://npm.io/package/@uplo/adapter-prisma.md) — 75 weekly downloads
- [typeorm-aios](https://npm.io/package/typeorm-aios.md) — 30 weekly downloads
## Recent versions
- 2.2.1 (latest) — 2020-08-31
- 2.0.1 — 2020-08-31
- 1.0.0 — 2020-08-28
## README
Nestjs Typeorm paginate
Pagination helper method for TypeORM repostiories or queryBuilders with strict typings
## Install
```bash
$ yarn add nestjs-typeorm-paginate
```
## Usage
##### Service
###### Repository
```ts
import {Injectable} from '@nestjs/common';
import {Repository} from 'typeorm';
import {InjectRepository} from '@nestjs/typeorm';
import {CatEntity} from './entities';
import {paginate, Pagination, IPaginationOptions} from 'nestjs-typeorm-paginate';
@Injectable()
export class CatService {
constructor (
@InjectRepository(CatEntity) private readonly repository: Repository,
) {}
async paginate(options: IPaginationOptions): Promise> {
return paginate(this.repository, options);
}
}
```
###### QueryBuilder
```ts
import {Injectable} from '@nestjs/common';
import {Repository} from 'typeorm';
import {InjectRepository} from '@nestjs/typeorm';
import {CatEntity} from './entities';
import {paginate, Pagination, IPaginationOptions} from 'nestjs-typeorm-paginate';
@Injectable()
export class CatService {
constructor (
@InjectRepository(CatEntity) private readonly repository: Repository,
) {}
async paginate(options: IPaginationOptions): Promise> {
const queryBuilder = this.repository.createQueryBuilder('c');
queryBuilder.orderBy('c.name', 'DESC'); // Or whatever you need to do
return paginate(queryBuilder, options);
}
}
```
##### Controller
```ts
import {Controller, Get, Query} from '@nestjs/common';
import {CatService} from './cat.service';
import {CatEntity} from './cat.entity';
import {Pagination} from 'nestjs-typeorm-paginate';
@Controller('cats')
export class CatsController {
constructor(private readonly catService: CatService) {}
@Get('')
async index(
@Query('page') page: number = 1,
@Query('limit') limit: number = 10,
): Pagination {
limit = limit > 100 ? 100 : limit;
return this.catService.paginate({
page,
limit,
route: 'http://cats.com/cats',
});
}
}
```
### Example Response
```json
{
"items": [
{
"lives": 9,
"type": "tabby",
"name": "Bobby"
},
{
"lives": 2,
"type": "Ginger",
"name": "Garfield"
},
{
"lives": 6,
"type": "Black",
"name": "Witch's mate"
},
{
"lives": 7,
"type": "Purssian Grey",
"name": "Alisdaya"
},
{
"lives": 1,
"type": "Alistair",
"name": "ali"
},
...
],
"meta": {
"itemCount": 10,
"totalItems": 20,
"itemsPerPage": 10,
"totalPages": 5,
"currentPage": 2
},
"links" : {
"first": "http://cats.com/cats?limit=10",
"previous": "http://cats.com/cats?page=1&limit=10",
"next": "http://cats.com/cats?page=3&limit=10",
"last": "http://cats.com/cats?page=5&limit=10"
}
}
```
`items`: An array of SomeEntity
`meta.itemCount`: The length of items array (i.e., the amount of items on this page)
`meta.totalItems`: The total amount of SomeEntity matching the filter conditions
`meta.itemsPerPage`: The requested items per page (i.e., the `limit` parameter)
`meta.totalPages`: The total amount of pages (based on the `limit`)
`meta.currentPage`: The current page this paginator "points" to
`links.first`: A URL for the first page to call | `""` (blank) if no `route` is defined
`links.previous`: A URL for the previous page to call | `""` (blank) if no previous to call
`links.next`: A URL for the next page to call | `""` (blank) if no page to call
`links.last`: A URL for the last page to call | `""` (blank) if no `route` is defined
## Find Parameters
```ts
@Injectable()
export class CatService {
constructor (
@InjectRepository(CatEntity) private readonly repository: Repository,
) {}
async paginate(options: IPaginationOptions): Promise> {
return paginate(this.repository, options, {
lives: 9,
});
}
}
```
## Eager loading
Eager loading should work with typeorm's eager property out the box. Like so
```typescript
import {Entity, OneToMany} from 'typeorm';
@Entity()
export class CatEntity {
@OneToMany(t => TigerKingEntity, tigerKing.cats, {
eager: true,
})
tigerKings: TigerKingEntity[];
}
// service
class CatService {
constructor(
private readonly repository: Repository,
) {}
async paginate(page: number, limit: number): Promise> {
return paginate(this.repository, {page, limit});
}
}
```
#### QueryBuilder
However, when using the query builder you'll have to hydrate the entities yourself. Here is a crud example that I've used in the past.
```typescript
const results = paginate(queryBuilder, {page, limit});
return new Pagination(
await Promise.all(results.items.map(async (item: SomeEntity) => {
const hydrate = await this.someRepository.findByEntity(item);
item.hydrated = hydrate;
return item;
})),
results.meta,
results.links,
);
```
---
_Source: https://npm.io/package/nestjs-typeorm-paginate-aygiz · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._