Registry / web-framework / express-paginate

express-paginate

JSON →
library1.0.2jsnpmunverified

express-paginate is a Node.js middleware and view helper library designed for pagination within Express applications. It provides utilities to handle `req.skip` (aliased as `req.offset`), `req.query.limit`, and `req.query.page` automatically, simplifying the process of fetching paginated results from a database and generating pagination links. The current stable version is 1.0.2, released in 2016. The package has seen no significant updates or active development since then, indicating an effectively abandoned status. It differentiates itself by providing both server-side request parsing for pagination parameters and a view helper function (`paginate.href`) for rendering pagination controls in templates, integrating directly into the Express `req` and `res.locals` objects.

web-frameworkdatabase
npm install express-paginate
github ↗package ↗
INSTALL
IMPORT
SIG · EXPRESS-PAGINATE
E
express-paginate
web-frameworkjavascriptv1.0.2
Install
—
Import
—
Disk
—
Pass rate
0/ 6
Env Coverage0 / 6
glibc
18–22
musl
18–22
Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
node 18–226 runs
build_error
glibc
node 18–226 runs
build_error
Code
Verified usage

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

paginate
✓ const paginate = require('express-paginate');
✗ import paginate from 'express-paginate';
This package is CommonJS-only, released before widespread ESM adoption. Use `require` for full functionality.
paginate.middleware
✓ app.use(paginate.middleware(10, 50));
✗ import { middleware } from 'express-paginate';
The `middleware` function is a method on the `paginate` object returned by `require()`. Attempting to destructure it with ESM named imports will fail.
res.locals.paginate.href
✓ res.locals.paginate.href(req)(true)
The `href` function is exposed via `res.locals.paginate` after the middleware runs and is invoked with `req` first, then with specific page/param arguments.

This quickstart initializes an Express application with `express-paginate` middleware. It demonstrates how to apply pagination to a dummy dataset, using `req.skip` and `req.query.limit` to slice results, and mentions the `res.locals.paginate.href` helper for generating navigation links. It also includes the recommended security fix for `limit=0`.

const express = require('express'); const paginate = require('express-paginate'); const app = express(); // Dummy data for demonstration const items = Array.from({ length: 100 }, (_, i) => `Item ${i + 1}`); app.use(paginate.middleware(10, 50)); // Default limit 10, max limit 50 // Optional: Limit '0' for infinite results can be a security/performance risk // Add a middleware to prevent it if needed. app.all('*', (req, res, next) => { if (req.query.limit <= 10) { req.query.limit = 10; } next(); }); app.get('/items', (req, res) => { const { skip, query } = req; const limit = parseInt(query.limit, 10) || 10; const page = parseInt(query.page, 10) || 1; const paginatedItems = items.slice(skip, skip + limit); const itemCount = items.length; const pageCount = Math.ceil(itemCount / limit); res.json({ items: paginatedItems, page, pageCount, itemCount, pages: paginate.get // Example of generating page numbers (not directly in express-paginate, usually a helper) // For actual previous/next links, use res.locals.paginate.href // next_page: res.locals.paginate.href(req)(false, { someFilter: 'value', limit: limit + 5 }), // prev_page: res.locals.paginate.href(req)(true) }); }); const PORT = process.env.PORT || 3000; app.listen(PORT, () => { console.log(`Server running on http://localhost:${PORT}/items`); console.log('Try: http://localhost:3000/items?page=2&limit=5'); });
Debug
Known issues
breakingThe `paginate` middleware sets `req.skip` instead of `req.offset` since v0.1.0, though `req.offset` is internally aliased to `req.skip` for compatibility. Code expecting `req.offset` directly should use `req.skip` or be aware of the alias.
fix
Update database queries to use `req.skip` (e.g., `Model.find().skip(req.skip)`).
affects: >=0.1.0
gotchaPassing `?limit=0` to the pagination middleware will return all results. This can lead to severe performance and security issues (e.g., denial of service attacks) if not explicitly handled.
fix
Implement a custom middleware to enforce a minimum or default `limit` value if `req.query.limit` is `0` or too low (e.g., `if (req.query.limit <= 10) req.query.limit = 10;`).
affects: >=0.2.0
gotchaThis package is effectively abandoned, with no new releases or significant development since 2016. It may not be compatible with newer Node.js or Express versions, lacks modern features, and will not receive security updates.
fix
Consider migrating to a more actively maintained pagination library or implementing custom pagination logic, especially for new projects or applications requiring robust security and long-term support.
affects: >=1.0.0
gotchaThe package uses CommonJS (`require`). Attempting to use ESM `import` statements directly will not work as expected and can lead to errors when trying to access named exports like `middleware`.
fix
Ensure your project or file uses `require('express-paginate')` for importing the library. If using a pure ESM environment, you may need a wrapper or a different library.
affects: >=0.1.0
Errors
Common errors & fixes
TypeError: paginate.middleware is not a function
Incorrect import statement (e.g., using `import { middleware } from 'express-paginate'` in ESM) or trying to access it before the `require` statement.
fix
Ensure you are using `const paginate = require('express-paginate');` and then calling `app.use(paginate.middleware(...));`.
Cannot read properties of undefined (reading 'skip') (or similar for 'limit')
The `paginate.middleware` was not applied before attempting to access `req.skip` or `req.query.limit` in a route handler, or the middleware failed to execute.
fix
Verify that `app.use(paginate.middleware(limit, maxLimit));` is called globally or on the specific routes *before* the route handler that accesses `req.skip`.
Error: Can't set headers after they are sent to the client.
While not specific to `express-paginate`, this can occur if an error or previous response sends headers before `express-paginate` attempts to modify `res.locals` or if a subsequent middleware/route sends a response after `express-paginate`'s operations were meant to be completed and another response was inadvertently sent.
fix
Review middleware order and ensure only one response is sent per request-response cycle. Place `express-paginate` early in the middleware chain if it's meant to apply broadly.
Upgrade
Version history
1.0.2latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
6 hits · last 30 days
node
6
Resources
githubhttps://github.com/expressjs/express-paginate ↗
packagehttps://www.npmjs.com/package/express-paginate ↗
express-paginate — npm install express-paginate · libregistry