pagination-express

> Node.js pagination-express is the complete pagination solution.

Install

``bash

npm install -save pagination-express

or

npm install pagination-express


or

npm i pagination-express


`

API

`js
const { pagination } = require("pagination-express");
`

HOW TO USE

`js


const query = {
where:{
status:1
},
order: [["id", "DESC"]],
};

const option = {
req: req,
page: 2,
limit: 5,
metatag: "paginationInfo", // Optional for changeing default name of metatag
lists: "userlist", // Optional for changeing default name of lists
range: 5, // Optional if need paging
};


// ## method 1
pagination(Users, option, { ...query }, (response) => {
res.json({ payload: response });
});

// Or

// ## method 2
// you need a async function to use it
const response = await pagination(Users, option, { ...query });
res.json({ payload: response });


`

Example 1 with Sequelize ORM

`js
// # app.js

const express = require("express");
const app = express();
const { pagination } = require("./pagination");
// model define as any way
const db = require("./connection/db");
const Users = db.users;
// or
// const Users = require("./connection/db").users;

app.get("/users", (req, res) => {
// get page number from req as nay method as your wish
const { page, limit } = req.query;

// you can use all sequelize ORM query here........
const query = {
// attributes: ["firstName", "lastName"],
where:{
status:1
},
order: [["id", "DESC"]],
};

const option = {
req: req,
page: page,
limit: 10, // give a limit
metatags: "paginationInfo", // Optional for change default name of metatags
lists: "userlist", // Optional for change default name of list
range: 5
};



pagination(Users, option, { ...query }, (response) => {
res.json({ payload: response });
});

// or you can use anohter method

// you need a async function to run it
// const response = await pagination(Users, option, { ...query });
// res.json({ payload: response });



});
`



`json

// # Output


// http://localhost:3000/users?page=2&limit=5

{
"payload": {
"metatags": {
"status": true,
"totalList": 101,
"currentList": 5,
"totalPage": 21,
"hasNextPage": true,
"hasPreviousPage": true,
"page": {
"totalPage": 21,
"currentPage": 2,
"nextPage": 3,
"previousPage": 1
},
"currentPage": {
"page": 2,
"url": "http://localhost/users?page=2&limit=5"
},
"nextPage": {
"page": 3,
"url": "http://localhost/users?page=3&limit=5"
},
"previousPage": {
"page": 1,
"url": "http://localhost/users?page=1&limit=5"
},
"paging": [
{
"active": false,
"page": 1
},
{
"active": true,
"page": 2
},
{
"active": false,
"page": 3
},
{
"active": false,
"page": 4
},
{
"active": false,
"page": 5
}
]
},
"list": [
{
"id": 96,
"firstName": "demo95",
"lastName": "user"
},
{
"id": 95,
"firstName": "demo94",
"lastName": "user"
},
{
"id": 94,
"firstName": "demo93",
"lastName": "user"
},
{
"id": 93,
"firstName": "demo92",
"lastName": "user"
},
{
"id": 92,
"firstName": "demo91",
"lastName": "user"
}
]
}
}


`

Change default name of object field

1. metatags
2. list



`js

const option = {
req: req,
page: page,
limit: 10,
metatags: "paginationInfo", // Optional for change default name of metatag
lists: "userlist", // Optional for change default name of list
range: 5
};

`

use can use it with async function also

`js

const response = await pagination(Users, option, { ...query });
res.json({ payload: response });


``

License

[MIT][license-url]

[downloads-url]: https://npmjs.org/package/pagination-express