npmpackage.info

Gathering detailed insights and metrics for knex-paginate

Other packages similar to knex-paginate

fastify-knex-paginate

1.0.0

A module for Fastify to support Knex's query builder with paginate method

knex-paginator

2.0.0

Simple paginator for Knex. It adds the .paginate() function to knex's query builder.

@ditdot/knex-paginate

2.0.1

Extension of Knex's query builder with `paginate` method that will help with your pagination tasks.

knex-pages

1.0.0

📄 Easily implement pagination into your Knex.js project.

Gathering detailed insights and metrics for knex-paginate

knex-paginate

An extension of Knex's query builder with `paginate` method that will help with your pagination tasks.

3.2.0

114

MIT

JavaScript

760.00 B

2,892,444 3.4

Installations

npm install knex-paginate

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

20.16.0

NPM Version

10.8.1 Score

89.1

Supply Chain

95.9

Quality

76.5

Maintenance

100

Vulnerability

98.9

License

Pull Requests

Open

0

Total

28

Closed

3

Merged

25

Issues

Open

2

Total

33

Closed

31

Releases

Release 3.2.0

v3.2.0

Updated on Dec 23, 2024

Release 3.1.4

v3.1.4

Updated on Jun 04, 2024

Release 3.1.3

v3.1.3

Updated on Jun 04, 2024

Release 3.1.2

v3.1.2

Updated on Apr 14, 2024

Release 3.1.1

v3.1.1

Updated on Apr 26, 2023

Release 3.1.0

v3.1.0

Updated on Mar 19, 2023

View All 17 releases

Languages

JavaScript

TypeScript

JavaScript (87.87%)

TypeScript (12.13%)

Developer

felixmosh

Download Statistics

Total Downloads

2,892,444

Last Day

376

Last Week

20,024

Last Month

100,092

Last Year

1,022,492

GitHub Statistics

MIT License

114 Stars

92 Commits

15 Forks

2 Watchers

3 Branches

4 Contributors

Updated on Jun 03, 2025

Bundle Size

1.42 kB

Minified

760.00 B

Minified + Gzipped

Bundlephobia

Maintainers

View All 4 Contributors

Package Meta Information

Latest Version

3.2.0

Package Id

knex-paginate@3.2.0

Unpacked Size

9.68 kB

Size

3.66 kB

File Count

NPM Version

10.8.1

Node Version

20.16.0

Published on

Dec 23, 2024

Total Downloads

Cumulative downloads

Total Downloads

2,892,444

Last Day

-45.7%

376

Compared to previous day

Last Week

-13.9%

20,024

Compared to previous week

Last Month

-11.9%

100,092

Compared to previous month

Last Year

45.6%

1,022,492

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

knex

Dev Dependencies

@types/jest @types/node auto-changelog dotenv jest knex knex-mock-client mysql2 prettier release-it stringcase tsd

Knex-paginate

Extension of Knex's query builder with paginate method that will help with your pagination tasks.

How to set up

To use this lib, first you will have to install it:

npm i knex-paginate --save
// or
yarn add knex-paginate

Then, add the following lines to your Knex set up:

1const knex = require('knex')(config);
2
3const { attachPaginate } = require('knex-paginate');
4attachPaginate();

Function definition

1.paginate(params: IPaginateParams): Knex.QueryBuilder<any, IWithPagination<TResult>>;
2
3interface IPaginateParams {
4  perPage: number,
5  currentPage: number,
6  isFromStart?: boolean,
7  isLengthAware?: boolean,
8  disabled?: boolean,
9}
10
11interface IWithPagination<T = any> {
12  data: T;
13  pagination: IPagination;
14}
15
16interface IPagination {
17  total?: number;
18  lastPage?: number;
19  prevPage?: number | null;
20  nextPage?: number | null;
21  currentPage: number;
22  perPage: number;
23  from: number;
24  to: number;
25}

How to use

Example

1const result = await knex('persons')
2   .paginate({ perPage: 10, currentPage: 2 });
3// result.data - will hold persons data
4// result.pagination - will hold pagination object

paginate options

Key	type	Value
perPage	number	Items per page.
currentPage	number	The current page
isFromStart / isLengthAware	boolean	Indicates if the returned list should get all pages till currentPage
disabled	boolean	Disables the pagination functionality, returns all relevant rows

`pagination` object

Key	Value
perPage	Items per page.
currentPage	Current page number.
from	Counting ID of the first item of the current page.
to	Counting ID of the last item of the current page.

If isLengthAware == true or currentPage == 1 or isFromStart == true pagination object will contain additional fields:

Key	Value
total	Total items that the full query contains.
lastPage	Last page number.
nextPage	The next page or `null` when at the last page.
prevPage	The previous page or `null` when at the first page.

This lib got inspiration from knex-paginator.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

5

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

1

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

3.4

/10

Last Scanned on 2025-06-23

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

knex-paginate - 3.2.0 | npmpackage.info