SDK
SDK Javascript v5.x
1

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 nameTypeDescriptionget/set
aggregationsobjectThe result of an aggregation produced by a search requestget
collectionCollectionThe collection associated to this documentget
documentsDocument[]An array of instantiated Document objectsget
fetchednumberThe number of fetched documents so farget/set
optionsobjectThe arguments of the search/scroll requestget
filtersobjectThe filters of the search requestget
totalintegerThe total number of results that can be fetchedget