Prisma Paginator

prisma-paginator is a lightweight and flexible pagination utility for Prisma. It enables clean pagination logic with filtering, sorting, and navigation links, and is ideal for integration into custom PrismaService classes—without extending any base class.

🚀 Installation

Install the module via npm yarn or pnpm:

1$ npm install prisma-paginator

1$ yarn add prisma-paginator

1$ pnpm add prisma-paginator

📦 Usage

1. Add paginate method to your PrismaService Class

Use getPaginatorFunc to bind pagination logic to your Prisma service class:

1import { PrismaClient } from "@prisma/client";
2import { getPaginatorFunc } from "prisma-paginator";
3
4//create prima service class
5export class PrismaService extends PrismaClient {
6  constructor() {
7    super({ errorFormat: "pretty", datasourceUrl: "DATABASE_URL" });
8  }
9  paginate<T>(
10    model: string,
11    pageOption: PageOption,
12    prismaParams?: PrismaParams
13  ) {
14    const paginateWithClient = getPaginatorFunc(this);
15    return paginateWithClient<T>(model, pageOption, prismaParams);
16  }
17
18  // Add your custom methods below...
19}

Example Usage

1//Can be added via the HTTP requests (body or query)
2const pageOption: PageOption = {
3  page: 1,
4  size: 10,
5  sort: ["name=asc"],
6  filter: ["isVerified==true", "country==FR"],
7};
8
9const prismaService = new PrismaService();
10
11async function getPaginatedUsers(pageOption) {
12  const prismaParams: PrismaParams = {
13    where: { isAdmin: false },
14  };
15
16  const paginatedUsers = await prismaService.paginate(
17    "user",
18    pageOption,
19    prismaParams
20  );
21  console.log(paginatedUsers);
22}
23
24getPaginatedUsers();

2. paginate Function

The standalone paginate function can be used independently and directly with a PrismaClient instance.

1import { PrismaClient } from "@prisma/client";
2import { paginate } from "prisma-paginator";
3
4const prisma = new PrismaClient({
5  errorFormat: "pretty",
6  datasourceUrl: "DATABASE_URL",
7});
8
9const pageOption: PageOption = {
10  page: 1,
11  size: 10,
12  sort: ["name=desc"],
13  nestedFilter: ["address.city==Bolingo"],
14  route: "/users",
15};
16
17async function getPaginatedUsers(pageOption) {
18  const paginatedUsers = await paginate(prisma, "user", pageOption);
19  console.log(paginatedUsers);
20}
21
22getPaginatedUsers();

🧪 API

PrismaService.paginate method

Parameters

• model (string): The name of the Prisma model.
• pageOption (PageOption): Options for pagination.
• prismaParams (PrismaParams, optional): Additional Prisma syntax query parameters.

Returns

• Promise<Page>: A promise that resolves to a paginated result.

paginate function

Parameters

• prisma (PrismaClient): An instance of PrismaClient.
• model (string): The name of the Prisma model.
• pageOption (PageOption): Options for pagination.
• prismaParams (PrismaParams, optional): Additional Prisma query syntax parameters.

Returns

• Promise<Page>: A promise that resolves to a paginated result.

📘 Types

PageOption

1interface PageOption {
2  page?: number;
3  size?: number;
4  filter?: string[];
5  nestedFilter?: string[];
6  sort?: string[];
7  route?: string;
8}

PrismaParams

1interface PrismaParams {
2  where?: unknown;
3  select?: unknown;
4  include?: unknown;
5  orderBy?: unknown;
6}

Page

1interface Page<T> {
2  content: T[];
3  metaData: {
4    page: number;
5    size: number;
6    totalPages: number;
7    totalCount: number;
8    sort?: unknown[];
9  };
10  links?: {
11    first: string;
12    prev: string;
13    next: string;
14    last: string;
15  };
16}

📝 License

This project is licensed under the MIT License.