SDK Javascript v5.x

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

Constructor #

This object can only be instantiated internally by this SDK, and is an easy-to-use representation of a paginated result from a search or a scroll request.

Properties #

Property name Type Description get/set
aggregations object The result of an aggregation produced by a search request get
collection Collection The collection associated to this document get
documents Document[] An array of instantiated Document objects get
fetched number The number of fetched documents so far get/set
options object The arguments of the search/scroll request get
filters object The filters of the search request get
total integer The total number of results that can be fetched get