Prisma-paginator NPM

Prisma Paginator

prisma-paginator A simple and flexible pagination module for Prisma, designed to be used with any Node.js project, including NestJS and Next.js. It provides two methods for paginating Prisma queries: one as a method in a class that extends PrismaClientPaginated, and another as a standalone paginate function.

Installation

Install the module via npm:

$ npm install prisma-paginator

$ yarn add prisma-paginator

Usage

1. PrismaClientPaginated Class

The PrismaClientPaginated class extends PrismaClient and adds a paginate method. This method can be used to paginate queries on any Prisma model.

import { PrismaClient } from "@prisma/client";
import { PrismaClientPaginated } from "prisma-paginator";

//create prima service class
export class PrismaService extends PrismaClientPaginated {
  constructor() {
    super({ errorFormat: "pretty", datasourceUrl: "DATABASE_URL" });
  }
  //Other methods
}

//Can be added via the HTTP requests (body or query)
const pageOption: PageOption = {
  page: 1,
  size: 10,
  sort: ["name=asc"],
  filter: ["isVerified==true", "country==FR"],
};

async function getPaginatedUsers(pageOption) {
  const prismaService = new PrismaService();

  const prismaParams: PrismaParams = {
    where: { isAdmin: false },
  };

  //use prisma service
  const paginatedUsers = await prismaService.paginate(
    "user",
    pageOption,
    prismaParams
  );
  console.log(paginatedUsers);
}

getPaginatedUsers();

2. paginate Function

The paginate function provides the same pagination functionality but can be used independently of the PrismaClientPaginated class. It requires a PrismaClient instance as the first parameter.

import { PrismaClient } from "@prisma/client";
import { paginate } from "prisma-paginator";

const prisma = new PrismaClient({
  errorFormat: "pretty",
  datasourceUrl: "DATABASE_URL",
});

const pageOption: PageOption = {
  page: 1,
  size: 10,
  sort: ["name=desc"],
  nestedFilter: ["address.city==Bolingo"],
  route: "/users",
};

async function getPaginatedUsers(pageOption) {
  const paginatedUsers = await paginate(prisma, "user", pageOption);
  console.log(paginatedUsers);
}

getPaginatedUsers();

API

PrismaClientPaginated.paginate

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

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

interface PageOption {
  page?: number;
  size?: number;
  filter?: string[];
  nestedFilter?: string[];
  sort?: string[];
  route?: string;
}

PrismaParams

interface PrismaParams {
  where?: unknown;
  select?: unknown;
  include?: unknown;
  orderBy?: unknown;
}

Page

interface Page<T> {
  content: T[];
  metaData: {
    page: number;
    size: number;
    totalPages: number;
    totalCount: number;
    sort?: unknown[];
  };
  links?: {
    first: string;
    prev: string;
    next: string;
    last: string;
  };
}