Interface FetchResultWithStats

Describes the fetch result, which should be the resolve value of the fetch function.

typeparam

see [[ItemType]]

see

DataQueryOptions

Type parameters

Type parameter Description
ItemType

isDone

isDone: undefined | false | true

If true, this will tell the DataQuery not to ignore subsequent DataQuery.fetchMore calls until a new fresh fetch. This will also update DataQuery.totalItems

items

items: ItemType[]

The actual items that result from the fetch. Note that this should be the items starting at the offset given in the FetchQuery. For instance, if the query wants items starting from offset 20, the first element of the item should be the item at offset 20.

total

total: undefined | number

If specified, this will be updated in the DataQuery and will be used as the value of DataQuery.totalItems.

Generated using TypeDoc