prisma-paginate

library6.0.0jsnpmunverified

A pagination extension for Prisma ORM that adds a .paginate() method to Prisma client models. Current stable version is 6.0.0, compatible with Prisma >=7.0.0. Provides page/limit-based pagination with result metadata (totalPages, hasNextPage, hasPrevPage, count). Ships TypeScript types and supports ESM and CommonJS. Differentiator: simple API, no additional config required, works with any Prisma client instance.

database

npm install prisma-paginate

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · PRISMA-PAGINATE

prisma-paginate

databasejavascriptv6.0.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

PrismaPaginate

✓ import PrismaPaginate from 'prisma-paginate'

✗ const PrismaPaginate = require('prisma-paginate')

ESM default import works with TypeScript and Node.js ESM. For CommonJS, use require('prisma-paginate').default

Pagination

✓ import { Pagination } from 'prisma-paginate'

✗ const Pagination = require('prisma-paginate').Pagination

Named export for helper class used with raw SQL queries

PaginationArgs, PrismaFindManyArgs, PaginatedResult

✓ import { PaginationArgs, PaginatedResult } from 'prisma-paginate'

Type imports for TypeScript users. Use import type for better compilation

Demonstrates basic setup and pagination query with PrismaPaginate extension on Prisma client.

import { PrismaClient } from '@prisma/client'; import PrismaPaginate from 'prisma-paginate'; const prisma = new PrismaClient(); const xprisma = prisma.$extends(PrismaPaginate); async function main() { const result = await xprisma.user .paginate( { where: { active: true }, orderBy: { createdAt: 'desc' } }, { page: 1, limit: 50 }, ); console.log(result.result); console.log(result.totalPages); console.log(result.hasNextPage); console.log(result.hasPrevPage); console.log(result.count); } main().catch(console.error);

Debug

Known issues

breakingPrisma-paginate v6.0.0 requires Prisma >=7.0.0 but older versions use v5.2.2 for Prisma 4.16.0

fix

Use prisma-paginate@5.2.2 with Prisma 4.16.0 - 6.x, or upgrade Prisma to >=7.0.0 for v6

affects: >=6.0.0

breakingIn v5, combined args syntax (findMany and pagination together) was supported. v6 requires separate arguments or uses different signature.

fix

Check API reference to use correct signature (separate pagination object)

affects: >=6.0.0

deprecatedUsing .paginate() without calling $extends first will fail. The extension must be applied to enable pagination on models.

fix

Always assign extended client to a variable and use that: const xprisma = prisma.$extends(PrismaPaginate); xprisma.user.paginate(...)

affects: >=5.0.0

gotchaCommonJS require returns the default export as { default: PrismaPaginate }; using require('prisma-paginate') will be undefined

fix

Use const PrismaPaginate = require('prisma-paginate').default; or use ESM import

affects: >=5.0.0

Errors

Common errors & fixes

TypeError: prisma.user.paginate is not a function

Forgot to call $extends(PrismaPaginate) on the Prisma client instance

fix

Create extended client: const xprisma = prisma.$extends(PrismaPaginate); then use xprisma.user.paginate(...)

Error: Unknown model paginate. Did you forget to run prisma generate?

Prisma client not generated after adding prisma-paginate or misconfigured extension

fix

Run npx prisma generate and ensure PrismaPaginate is imported correctly

TypeError: require(...).default is not a function

Used CommonJS require incorrectly; prisma-paginate is ESM-first

fix

Use const PrismaPaginate = require('prisma-paginate').default; or switch to ESM import

Cannot find module 'prisma-paginate' or its corresponding type declarations

Missing installation or TypeScript tsconfig not resolving module types

fix

Install prisma-paginate with npm install prisma-paginate; ensure tsconfig includes node module resolution

Upgrade

Version history

6.0.0latest on npm

Audit

Dependencies

@prisma/clientrequiredPeer dependency required to extend Prisma client with pagination functionality

prismaoptionalPeer dependency for Prisma CLI and schema generation

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/sandrewTx08/prisma-paginate ↗

packageprisma-paginate ↗

homepagehttps://github.com/sandrewTx08/prisma-paginate#readme ↗