@execaman/pagination

Contents

• Import
  • Node.js
  • Browser
• Usage
• Properties
  • .left
  • .right
• Getters
  • .size
  • .page
  • .pages
  • .current
  • .previous
  • .next
• Methods
  • .first(jump)
  • .last(jump)
  • .at(page)
  • .jump(page)
  • .find(query, all, jump)
  • .random(jump)
  • .erase()
• Contributing

Import

Node.js

import Book from "@execaman/pagination"; // ESM
// or
const Book = require("@execaman/pagination"); // CommonJS

Browser

// you can use any CDN
// preferably unpkg for latest version
<script src="https://unpkg.com/@execaman/pagination/lib/index.js" type="text/javascript"></script>
<script>
  console.log(new Book([1, 2, 3, 4, 5]));
</script>

Usage

const book = new Book(
  [6, 7, 8, 9, 10], // current pages
  [1, 2, 3, 4, 5] // previous pages (if any)
);

console.log(book.current); // 6

Properties

.left

list of previous pages (pages turned over)

returns: Page[]

.right

list of current pages (pages left to read)

returns: Page[]

Getters

.size

total number of pages

returns: number

.page

current page number

returns: number

.pages

array of all pages; previous pages are brought to the front

returns: Page[]

.current

the current page

returns: Page

.previous

the previous page

returns: Page | undefined

.next

the next page

returns: Page | undefined

Methods

.first(jump)

Parameter	Type	Optional	Default	Description
jump	boolean	Yes	false	whether to set the first page as the current page

returns: Page | undefined

.last(jump)

Parameter	Type	Optional	Default	Description
jump	boolean	Yes	false	whether to set the last page as the current page

returns: Page | undefined

.at(page)

Parameter	Type	Optional	Description
page	integer	No	page number; negative to look from back, positive for front

returns: Page | undefined

.jump(page)

Parameter	Type	Optional	Description
page	integer	No	page number; negative to look from back, positive for front

returns: Page | undefined

.find(query, all, jump)

Parameter	Type	Optional	Default	Description
query	(page: Page) => boolean	No	N/A	function to run over pages
all	boolean	Yes	false	whether to include previous pages in query
jump	boolean	Yes	false	whether to set it as the current page (if found)

returns: Page | undefined

.random(jump)

Parameter	Type	Optional	Default	Description
jump	boolean	Yes	false	whether to set it as the curent page

returns: Page | undefined

.erase()

erases both halves (previous and current pages) of the book, making it non-informative and non-functional

returns: void

Contributing

My opinion alone won't make this package as reliable as it would be with more people; if you want to report a bug, drop a suggestion, or are willing to contribute, please do so. I shall be grateful to assist or learn from you.

Copyright (c) 2023 Aman, under the MIT License