Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/felixmosh/knex-paginate
An extension of Knex's query builder with `paginate` method that will help with your pagination tasks.
https://github.com/felixmosh/knex-paginate
knex-paginate knex-query-builder
Last synced: 5 days ago
JSON representation
An extension of Knex's query builder with `paginate` method that will help with your pagination tasks.
- Host: GitHub
- URL: https://github.com/felixmosh/knex-paginate
- Owner: felixmosh
- License: mit
- Created: 2019-08-22T19:04:48.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-24T04:28:05.000Z (9 months ago)
- Last Synced: 2024-05-02T01:50:08.286Z (8 months ago)
- Topics: knex-paginate, knex-query-builder
- Language: JavaScript
- Homepage:
- Size: 1.11 MB
- Stars: 106
- Watchers: 4
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Knex-paginate
[](https://www.npmjs.com/package/knex-paginate)
[](https://github.com/felixmosh/knex-paginate/actions/workflows/ci.yml)
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
### Example
```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`](https://github.com/cannblw/knex-paginator).