koa-pagination

koa-pagination

koa-pagination is a middleware to handle Range Pagination Headers using Range & Content-Range entity-headers.

Status

Installation

Install the package via yarn:

❯ yarn add koa-pagination

or via npm:

❯ npm install koa-pagination --save

Configuration

The middleware can be configured with the following parameters:

• allowAll: Whether to accept * as range-specifier.
• maximum: Maximum number of items allowed per page (50 by default).
• unit: Range unit to be used when no Range header is provided (items by default).

You can change the defaults by doing:

middleware({
  allowAll: true,
  maximum: 100,
  unit: 'bytes'
});

Usage

const { middleware } = require('koa-pagination');
const Koa = require('koa');

const app = new Koa();

app.get('/', middleware(), async ctx => {
  // `paginate` middleware will inject a `pagination` object in the `koa` context,
  // which will allow you to use the `pagination.offset` and `pagination.limit`
  // in your data retrieval methods.
  ctx.body = await foobar.getData({
    limit: ctx.pagination.limit,
    offset: ctx.pagination.offset
  });

  // This is needed in order to expose the length in `Content-Range` header.
  ctx.pagination.length = foobar.count();
});

app.listen(3000);

Request

You can provide the Range header specifying the items you want to retrieve. For instance to retrieve the first 5 elements:

'Range: items=0-4'

You can also provide * at the end of the range in order to retrieve the all of the available items:

'Range: items=0-*'

Response

The first example will generate a response with the following Content-Range header:

'Content-Range: items 0-4/*'

The * will be replaced with the total number of items provided in the length variable.

Codes

Code	Reason
200	Range header has not been provided.
206	Range header is valid.
412	Range header is malformed.
416	Range header is invalid.
500	Incorrect middleware configuration or unexpected value inside middleware.

Tests

❯ yarn test

Release

❯ npm version [<new version> | major | minor | patch] -m "Release %s"

Changelog

v3.0.0 (2017-03-30)

• Move source to /src #45 (kurayama)
• Improve README #44 (kurayama)
• Replace default export by named middleware and errors #43 (nunofgs)
• Add .npmignore #42 (ruimarinho)
• Update koa@2 #40 (kurayama)
• Add LICENSE #41 (ruimarinho)
• Update README #38 (franciscocardoso)
• Add allowAll parameter to disable asterisk #37 (nunofgs)