2.0.0 • Published 6 years ago

@dadi/metadata v2.0.0

Weekly downloads
11
License
MIT
Repository
-
Last release
6 years ago

Metadata

Generates pagination metadata for result sets in DADI products.

npm (scoped)

{
  "page": 2,
  "limit": 20,
  "offset": 0,
  "totalCount": 200,
  "totalPages": 10,
  "nextPage": 3,
  "prevPage": 1  
}

Installation

$ npm install --save @dadi/metadata

Usage

The metadata function accepts two arguments:

argumentdescription
optionsthe options that were used to generate the data set
options.pagethe page number requested
options.limitthe number of records requested
options.skipthe number of records skipped
countthe total number of records in the original data set, before options were applied
var meta = require('@dadi/metadata')

var options = {
  page: 2,
  limit: 20
}

var metadata = meta(options, 200)