scrollSpecifications #

Returns a JSON object containing the next page of the scroll session, and the scrollId to be used in the next scroll action.
A scroll session is always initiated by a searchSpecification action with the scroll argument.

scrollSpecifications(scrollId, [options], callback) #

Arguments	Type	Description
`scrollId`	string	The "scrollId" provided with the last scrollSpecifications response or from the initial searchSpecifications request
`options`	JSON object	Optional parameters
`callback`	function	Callback handling the response

Options #

Option	Type	Description	Default
`queuable`	boolean	Make this request queuable or not	`true`
`scroll`	string	Re-initializes the scroll session timeout to its value. If not defined, the scroll timeout is defaulted to a Kuzzle configuration	`undefined`

Usage #

// Using callbacks (NodeJS or Web Browser)
kuzzle
  .collection('collection', 'index')
  .scrollSpecifications(scrollId, {scroll: '1m'}, function (err, res) {
    res.hits.forEach(function (specification) {
      console.log(specification);      
    });
    res.total // Total specifications count
  });
// Using promises (NodeJS only)
kuzzle
  .collection('collection', 'index')
  .scrollSpecificationsPromise(scrollId, {scroll: '1m'})
  .then(res => {
    res.hits.forEach(specification => {
      console.log(specification);
    });
    res.total // Total specifications count
  });

Callback response

{
  "hits": [{ "first": "specification" }, { "second": "specification" }],
  "total": 2
}

Edit this page on Github