typeorm-cursor-paginate

TypeORM Paginator

Cursor-based pagination that works with TypeORM Query Builder. Read about the general idea of cursor-based pagination here.

This package is a fork of the typeorm-paginator package with some tweaks. See the Key differences from typeorm-paginator section for more details.

The biggest difference is directional cursors. Directional cursors store the direction of pagination inside them. They allow to provide only one parameter to paginate in any direction.

• Installation
• Usage
  • Configuration
  • Paginating Results
    • Retrieving the First Page
    • Navigating to the Next Page
• Key differences from other packages
  • Key differences from typeorm-paginator
  • Key differences from typeorm-cursor-pagination
• Contributing
• License

Installation

npm install typeorm-cursor-paginate --save

Usage

Start by importing the CursorPaginator class:

import { CursorPaginator } from "typeorm-cursor-paginate";

Configuration

Instantiate the paginator with your target entity and define the ordering strategy. In this example, users are sorted by their name in ascending order and by id in descending order:

const paginator = new CursorPaginator(User, {
  orderBy: [{ name: "ASC" }, { id: "DESC" }],
});

Prepare your query:

const query = repoUsers.createQueryBuilder();
// you can apply desired "where" conditions to the query

Paginating Results

Retrieving the First Page

Use the paginator to fetch the initial set of results. Here, a limit of 2 items per page is specified:

const firstPageResult = await paginator.paginate(query, { limit: 2 });

Output structure:

{
  nodes: [
    User { id: 4, name: 'a' },
    User { id: 3, name: 'b' },
  ],
  hasPrevPage: false,
  hasNextPage: true,
  prevPageCursor: "some-cursor-string",
  nextPageCursor: "some-cursor-string",
}

Navigating to the Next Page

To retrieve the next set of results, pass the nextPageCursor from the first query:

const secondPageResult = await paginator.paginate(query, {
  limit: 2,
  // Use the nextPageCursor from the previous result
  pageCursor: firstPageResult.nextPageCursor,
});

Output structure:

{
  nodes: [
    User { id: 1, name: 'c' },
    User { id: 2, name: 'c' },
  ],
  hasPrevPage: true,
  hasNextPage: true,
  prevPageCursor: "some-cursor-string",
  nextPageCursor: "some-cursor-string",
}

Key differences from other packages

Key differences from typeorm-paginator

typeorm-paginator is the original package that this one is based on.

Here are the key differences:

• Directional cursors: In the original package, cursors are not directional. The pagination direction was determined by what argument the cursor is passed to. This package stores the direction of pagination inside the cursor. It allows to provide only one parameter to paginate in any direction.
• Type safety: Added some more type safety to the code. Now the orderBy property only accepts keys that are present in the entity.
• Removed PageCursor: The PageCursor class was removed. This package is about cursor-based pagination.
• No default "limit": Original package had a default limit of 20.Now, if the limit is omitted, all results will be returned.

Key differences from typeorm-cursor-pagination

typeorm-cursor-pagination is another package that provides cursor-based pagination for TypeORM. As of now, March 2025, it gets more and more popular than the typeorm-paginator package.

Here are the key differences:

• Can provide different directions for different columns in orderBy: In the original package, all columns in the orderBy array had to have the same direction. This package allows to provide different directions for different columns.
• Directional cursors: see above
• No default "limit": see above
• Custom transformation of the cursor: In the current package, custom transformers to stringify and parse the cursor can be provided. This feature comes from the original package (typeorm-paginator).

Contributing

All contributions are welcome, open a pull request or issue any time.

Please try to commit your changes using a descriptive commit message.

License

Released under the MIT License