Options
All
  • Public
  • Public/Protected
  • All
Menu

@fiquu/pagination

Build Status GitHub GitHub last commit npm (scoped) npm

Simple, dependency-free pagination component.

Installation

npm i @fiquu/pagination

Usage

import { createPagination, PaginationComponent } from '@fiquu/pagination';

const pagination: PaginationComponent = createPagination({ limit: 50 });

const { limit, skip } = pagination.paginate(3); // limit = 50; skip = 100;

// Or in some query...
const query = await Posts.find()
  .skip(pagination.skip(req.query.page))
  .limit(pagination.limit);

Documentation

Please see the documentation page for more details.

Index

Type aliases

PaginationConfig

PaginationConfig: { limit: number }

Type declaration

  • limit: number

    The limit per page.

Functions

createPagination

  • Pagination Component factory.

    Parameters

    • __namedParameters: { limit: number }
      • limit: number

    Returns PaginationComponent

    The component instance.

paginate

  • Calculates pagination parameters.

    Parameters

    • limit: number

      The limit to use.

    • page: number

      The page number to paginate.

    Returns PaginationPaging

    The calculated pagination parameters.

skip

  • skip(limit: number, page: number): number
  • Calculates the skip value according to the provided page number.

    Parameters

    • limit: number

      The limit to use.

    • page: number

      The page to calculate the skip value for.

    Returns number

    The skip count.

Legend

  • Property
  • Method

Generated using TypeDoc