npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

knex-paginator

v2.0.0

Published

Simple paginator for Knex. It adds the .paginate() function to knex's query builder.

Downloads

1,219

Readme

Knex-Paginator

Warning: do not use in production. This is not being actively maintained.

Simple paginator for Knex. It adds the .paginate() function to knex's query builder.

How to set up

To use this paginator, first you will have to install it:

npm i knex-paginator --save

Then, simply add the following lines to your Knex set up:

const knex = require('knex')(config);

const setupPaginator = require('knex-paginator');
setupPaginator(knex);

Function definition

paginate(perPage = 10, page = 1, isLengthAware = false)

| Argument | Description | | --- | --- | | perPage (integer, defaults to 10) | Items to show per page. | | page (integer, defaults to 1) | Current page. | | isLengthAware (boolean. Defaults to false) | Whether the paginator is aware of its length or not. |

Note: If isLengthAware is set to true, the performance will be worst, as it will have to perform an extra query to get the length.

How to use

Example with callback

knex('products')
    .where('price', '<', 20)
    .paginate(15, 1, true)
    .then(paginator => {
        console.log(paginator.current_page);
        console.log(paginator.data);
    });

Example with async/await

const paginator = await knex('products')
    .where('price', '<', 20)
    .paginate(15, 1, true);

console.log(paginator.current_page);
console.log(paginator.data);

The paginator object

The function returns an object that contains the following data:

Always returned:

| Key | Value | | --- | --- | | per_page | Items per page. | | current_page | Current page number. | | from | ID of the first item of the current page. | | to | ID of the last item of the current page. | | data | The actual data of the current page. |

Returned if isLengthAware == true:

| Key | Value | | --- | --- | | total | Total items that the full query contains. | | last_page | Last page number. |