TypeORM Paginator

It provides cursor-based pagination and page-based pagination. Even if there is a transformer in the column, it works perfectly.

Installation

1npm install typeorm-paginator --save

Usage

Cursor-based Pagination

1import { CursorPaginator } from 'typeorm-paginator'

Single cursor-based pagination.

1const paginator = new CursorPaginator(User, {
2  orderBy: {
3    id: false,
4  },
5})
6
7const pagination = await paginator.paginate(repoUsers.createQueryBuilder())
8
9expect(pagination).toEqual({
10  nodes: [
11    /*
12    User { id: 3 },
13    User { id: 2 },
14    User { id: 1 },
15    */
16  ],
17  hasPrev: false,
18  hasNext: false,
19  nextCursor: expect.any(String),
20  prevCursor: expect.any(String),
21})

Multi cursor-based pagination.

1const paginator = new CursorPaginator(User, {
2  orderBy: [
3    { name: true },
4    { id: false },
5  ],
6})
7
8const result = await paginator.paginate(repoUsers.createQueryBuilder(), { take: 2 })
9expect(result).toEqual({
10  nodes: [
11    User { id: 3, name: 'a' },
12    User { id: 5, name: 'b' },
13  ],
14  hasPrev: false,
15  hasNext: true,
16  prevCursor: expect.any(String),
17  nextCursor: expect.any(String),
18})
19
20const resultNext = await paginator.paginate(repoUsers.createQueryBuilder(), { take: 2, nextCursor: result.nextCursor })
21expect(resultNext).toEqual({
22  nodes: [
23    User { id: 2, name: 'b' },
24    User { id: 6, name: 'c' },
25  ],
26  hasPrev: true,
27  hasNext: true,
28  prevCursor: expect.any(String),
29  nextCursor: expect.any(String),
30})
31
32const resultNextNext = await paginator.paginate(repoUsers.createQueryBuilder(), { take: 2, nextCursor: resultNext.nextCursor })
33expect(resultNextNext).toEqual({
34  nodes: [
35    User { id: 4, name: 'c' },
36    User { id: 1, name: 'c' },
37  ],
38  hasPrev: true,
39  hasNext: false,
40  prevCursor: expect.any(String),
41  nextCursor: expect.any(String),
42})
43
44const resultNextNextPrev = await paginator.paginate(repoUsers.createQueryBuilder(), { take: 2, prevCursor: resultNextNext.prevCursor })
45expect(resultNextNextPrev).toEqual({
46  nodes: [
47    User { id: 2, name: 'b' },
48    User { id: 6, name: 'c' },
49  ],
50  hasPrev: true,
51  hasNext: true,
52  prevCursor: expect.any(String),
53  nextCursor: expect.any(String),
54})

Page-based Pagination

1import { PagePaginator } from 'typeorm-paginator'

Single cursor-based pagination.

1const paginator = new PagePaginator(User, {
2  orderBy: {
3    id: false,
4  },
5  take: 3,
6})
7
8const pagination1 = await paginator.paginate(repoUsers.createQueryBuilder())
9
10expect(pagination1).toEqual({
11  nodes: [
12    /*
13    User { id: 5 },
14    User { id: 4 },
15    User { id: 3 },
16    */
17  ],
18  hasNext: true,
19})
20
21const pagination1 = await paginator.paginate(repoUsers.createQueryBuilder(), { page: 2 })
22
23expect(pagination1).toEqual({
24  nodes: [
25    /*
26    User { id: 2 },
27    User { id: 1 },
28    */
29  ],
30  hasNext: false,
31})