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:

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

const { attachPaginate } = require('knex-paginate');
attachPaginate();
`

Function definition

`typescript
.paginate(params: IPaginateParams): Knex.QueryBuilder>;

interface IPaginateParams {
perPage: number,
currentPage: number,
isFromStart?: boolean,
isLengthAware?: boolean,
disabled?: boolean,
}

interface IWithPagination {
data: T;
pagination: IPagination;
}

interface IPagination {
total?: number;
lastPage?: number;
prevPage?: number | null;
nextPage?: number | null;
currentPage: number;
perPage: number;
from: number;
to: number;
}
`

How to use

$3


`javascript
const result = await knex('persons')
.paginate({ perPage: 10, currentPage: 2 });
// result.data - will hold persons data
// 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`.