softweb-paginator v1.0.12

Paginator

Paginator is a node module for paginating json objects.

Installation

Use the package manager npm to install softweb-paginator.

npm install softweb-paginator

Usage

Require

const Paginator = require("softweb-paginator");

Create Object

• @param {JSON}

const Paginator = require("softweb-paginator");
const paginator = new Paginator({});

paginate(currentPage,pageSize,cats)

• @param {number} currentPage
• @param {number} pageSize
• @param {JSON} cats Optional for paginating cats_mapping as well
• @summary Paginates the Object

const Paginator = require("softweb-paginator");
const paginator = new Paginator(params.data.items);
paginator.paginate(params.req.query.page, params.req.query.pageSize , cats_mapping);

getPaginatedCats()

• @returns {JSON} The paginated cats_mapping in case of pagination on them

const Paginator = require("softweb-paginator");
const paginator = new Paginator(params.data.items);
paginator.paginate(params.req.query.page, params.req.query.pageSize , cats_mapping);
const cats_mapping = paginator.getPaginatedCats();

getPaginatedData()

• @returns {JSON} The paginated object

const Paginator = require("softweb-paginator");
const paginator = new Paginator(params.data.items);
paginator.paginate(params.req.query.page, params.req.query.pageSize , cats_mapping);
const object = paginator.getPaginatedData();