The paginate request transform allows authors to take a paging criteria and generate paging related query param that is then appended to the configuration.url.

The paging criteria is provided via the options parameter with properties { size, offset }.

Example of Paging Criterion Transform

This example is a paging criterion that transforms to "?limit=5&offset=10:

{
    "size": 5,
    "offset": 10
}

Signature

The paginate transform function can be declared like this:

const paginate = function(configuration, options, transformsContext) {

  var c = configuration;
  // use the paging criteria provided on 'options' parameter to generate the appropriate query param
  // update c.url as needed

  return c;
}

This function has the following parameters:

• configuration an object with the following properties:
  • Refer to the signature in Request Transformation Functions for details on the various properties.
• options the paging criteria to transform:
  • size: Specifies how many rows to fetch. If a size is not specified, or size is set to -1 (some JET components, such as JET chart components, often request all rows by setting { size: -1 }. When this is the case, it might be necessary to handle -1 as size).
  • offset: Specifies which row to start the fetch from.
• transformsContext is an object that is set by the author (ServiceDataProvider, RestHelper, Call Rest action) to then be passed as is to all transforms for the current fetch cycle.

The function returns the updated configuration object.

Usages

// Paginate function that limits fetched to a max size of 100 
const paginate = (configuration, options, context) => {
  var c = configuration;
  var os = (options.size === -1 || options.size > 100) ? 100 : options.size;

  if (options) {
    c.url = appendToUrl(c.url, 'limit', os);
    c.url = appendToUrl(c.url, 'offset', options.offset);
  }
  return c;
}