README.md

Pagination Manager

• Pagination Manager is an useful framework for improving the use of object pagination in APIs like Discord.
• Lightweight module, ES6 and CommonJS compatible.
• Package developed by tnfAngel#6557

Usage

CommonJS

const { PaginationBuilder, PaginationManager } = require('pagination-manager');

const pagesBuilder = new PaginationBuilder()
    .addPages([{ hi: 'this is a page' }, { hi: 'this is another page'}])
    .setOptions({ infinitePages: true });

const paginationManager = new PaginationManager(pagesBuilder);

console.log(
    paginationManager.getCurrentPage()
); // { hi: 'this is a page' }

console.log(
    paginationManager.next()
); // { hi: 'this is another page'}

console.log(
    paginationManager.getCurrentPage()
); // { hi: 'this is another page'}

TypeScript

import { PaginationBuilder, PaginationManager } from 'pagination-manager';

type Page = { hi: string; };

const pagesBuilder = new PaginationBuilder<Page>()
    .addPages([{ hi: 'this is a page' }, { hi: 'this is another page'}])
    .setOptions({ infinitePages: true });

const paginationManager = new PaginationManager(pagesBuilder);

console.log(
    paginationManager.getCurrentPage()
); // { hi: 'this is a page' }

console.log(
    paginationManager.next()
); // { hi: 'this is another page'}

console.log(
    paginationManager.getCurrentPage()
); // { hi: 'this is another page'}

Documentation

Pagination Manager Classes

• PaginationBuilder | .PaginationBuilder() -> PaginationBuilder

Builder class for setup the pagination manager and configure the options.

const paginationBuilder = new PaginationBuilder()
    .addPages([Page1, Page2, Page3]) // Adds multiple pages to the PaginationBuilder.
    .addPage(Page4) // Adds a single page.
    .setPages([Page5, Page6, Page7]) //Set the pages in the array.
    .setOptions({ infinitePages: false }); // Pagination Manager options. infinitePages means if when reaching the end of pages, the current page will return to the beginning and vice versa.

const paginationManager = new PaginationManager(paginationBuilder);

• PaginationManager | .PaginationManager(PaginationBuilder) -> PaginationManager

Main class, provide all manager methods and properties.

const paginationManager = new PaginationManager(paginationBuilder); // PaginationBuilder constructor here.

Pagination Manager Class Methods

• GetCurrentPage | .getCurrentPage() -> CurrentPage

Returns the current active page. Default to 0.

PaginationManager.getCurrentPage();

• GetPages | .getPages() -> Pages

Returns alls the pages passed in PaginationBuilder class.

PaginationManager.getPages();

• Next | .next() -> Page

Sets the current page to the next page and return it.

PaginationManager.next();

• Prev | .prev() -> Page

Sets the current page to the previous page and return it.

PaginationManager.prev();

• First | .first() -> Page

Sets the current page to the first page and return it.

PaginationManager.first();

• Last | .last() -> Page

Sets the current page to the last page and return it.

PaginationManager.last();

• SetPage | .setPage(page) -> Page

Sets the current page to the page provided and return it. Pages will start with 0.

PaginationManager.setPage(0);

• SetHumanPage | .setHumanPage(page) -> Page

Sets the current page to the page provided and return it. Same as SetPage but pages will start with 1.

PaginationManager.setHumanPage(1);

• GetPage | .getPage(page) -> Page

Returns the page provided. Pages will start with 0.

PaginationManager.getPage(0);

• GetHumanPage | .getHumanPage(page) -> Page

Returns the page provided. Same as GetPage but pages will start with 1.

PaginationManager.getHumanPage(1);

Pagination Manager Class Property's

• Pages | .pages -> Page[]

Returns alls the pages passed in PaginationBuilder class.

PaginationManager.pages; // [...]

• Options | .options -> PaginationBuilderOptions

Returns the options passed in PaginationBuilder class.

PaginationManager.options; // {...}

• PagesSize | .pagesSize -> number

Returns the pages size starting with 0.

PaginationManager.pagesSize; // 2

• HumanPagesSize | .humanPagesSize -> number

Returns the pages size starting with 1.

PaginationManager.humanPagesSize; // 3

• CurrentPageIndex | .currentPageIndex -> number

Returns the current page index starting with 0.

PaginationManager.currentPageIndex; // 0

• HumanCurrentPageIndex | .humanCurrentPageIndex -> number

Returns the current page index starting with 1.

PaginationManager.humanCurrentPageIndex; // 1

• NextPageIndex | .nextPageIndex -> number

Returns the next page index starting with 0.

PaginationManager.nextPageIndex; // 1

• HumanNextPageIndex | .humanNextPageIndex -> number

Returns the next page index starting with 1.

PaginationManager.humanNextPageIndex; // 2

• PrevPageIndex | .prevPageIndex -> number

Returns the previous page index starting with 0.

PaginationManager.prevPageIndex; // 0

• HumanPrevPageIndex | .humanPrevPageIndex -> number

Returns the previous page index starting with 1.

PaginationManager.humanPrevPageIndex; // 1

• PageIndicator | .pageIndicator -> string

Returns an human-readable string with the human current page index and the human page size.

PaginationManager.pageIndicator; // 1/3

• CurrentPage | .currentPage -> CurrentPage

Returns the current page element.

PaginationManager.currentPage; // {...}

Installation

If you have installation issues, join our support server.

Node Package Manager (NPM)

1. Open: Terminal/CMD
2. Put: npm i pagination-manager

Yarn

1. Open: Terminal/CMD
2. Put: yarn add pagination-manager