jetspeed-knex-paginator v2.0.0

Knex-Paginator

Warning: do not use in production. This is not being actively maintained.

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

How to set up

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

npm i knex-paginator --save

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

const knex = require('knex')(config);

const setupPaginator = require('knex-paginator');
setupPaginator(knex);

Function definition

paginate(perPage = 10, page = 1, isLengthAware = false)

Note: If isLengthAware is set to true, the performance will be worst, as it will have to perform an extra query to get the length.

How to use

Example with callback

knex('products')
    .where('price', '<', 20)
    .paginate(15, 1, true)
    .then(paginator => {
        console.log(paginator.current_page);
        console.log(paginator.data);
    });

Example with async/await

const paginator = await knex('products')
    .where('price', '<', 20)
    .paginate(15, 1, true);

console.log(paginator.current_page);
console.log(paginator.data);

The paginator object

The function returns an object that contains the following data:

Always returned:

Returned if isLengthAware == true: