Paginator

Generic pagination algorithm wrapped in a CommonJS module.

Overview

When developing any kind of application that involves fetching an arbitrary number of elements from somewhere, you'll almost always want some form of pagination. It's impossible to tell in advance how the rest of the application will work, so a generic module that does -only- the pagination algorithm is useful. Enter Paginator.

Usage

Also see the documentation.

1var Paginator = require("paginator");
2
3// Arguments are `per_page` and `length`. `per_page` changes the number of
4// results per page, `length` changes the number of links displayed.
5var paginator = new Paginator(30, 7);
6
7// Arguments are `total_results` and `current_page`. I hope these are self
8// explanatory.
9var pagination_info = paginator.build(10000, 50);
10
11// The returned object will look something like this.
12{
13  total_pages: 334,
14  current_page: 50,
15  first_page: 46,
16  last_page: 53,
17  previous_page: 49,
18  next_page: 51,
19  has_previous_page: true,
20  has_next_page: true,
21  total_results: 10000,
22  results: 30,
23  first_result: 1470,
24  last_result: 1499,
25}

License

Licensed under an MIT license.