json-pager

Description

json-pager is a lightweight JavaScript library that provides a simple and efficient way to paginate JSON arrays. It's designed to be easy to use and integrate into your projects.

Installation

npm install json-pager

Usage

import { paginate } from 'json-pager';

const items = [
  { id: 1, name: 'Item 1' },
  { id: 2, name: 'Item 2' },
  { id: 3, name: 'Item 3' },
  { id: 4, name: 'Item 4' },
  { id: 5, name: 'Item 5' },
  { id: 6, name: 'Item 6' },
  { id: 7, name: 'Item 7' },
  { id: 8, name: 'Item 8' },
  { id: 9, name: 'Item 9' },
  { id: 10, name: 'Item 10' }
];

const { results, pagination } = paginate(items, 3, 2); // Page size of 3, page number 2

console.log(results); // Output: [{id: 4, name: 'Item 4'}, {id: 5, name: 'Item 5'}, {id: 6, name: 'Item 6'}]
console.log(pagination);
// Output: {
//   totalItems: 10,
//   limit: 3,
//   offset: 3,
//   totalPages: 4,
//   hasNext: true,
//   hasPrev: true,
//   currentPage: 2
// }

API

paginate(items: any[], pageSize: number, pageNumber: number)

• items: The array of items to paginate.
• pageSize: The number of items per page.
• pageNumber: The page number to retrieve (starts at 1). Returns:

An object with the following properties:

• results: An array containing the items for the current page.
• pagination: An object containing pagination metadata:
  • totalItems: The total number of items.
  • limit: The number of items per page.
  • offset: The starting index of the current page.
  • totalPages: The total number of pages.
  • hasNext: true if there is a next page, false otherwise.
  • hasPrev: true if there is a previous page, false otherwise.
  • currentPage: The current page number.

License

MIT