DataQueryOptions | mobx-ui-statelets

Describes how the DataQuery is customized.

Type parameters

Type parameter	Description
QueryType	see DataQuery
ItemType	see DataQuery

fetch
fetchLimit
name

fetch

fetch: TaskAction<FetchQuery<QueryType>, FetchResultWithStats<ItemType> | ItemType[] | Falsy, void>

Specfies the fetch logic, which is essentially a Task action. This should resolve to a standardized FetchResultWithStats structure, or a plain array of your items, or a falsy value to indicate that the fetch encountered an error.

You should also take advantage of the TaskHelpers to cancel fetch attempts properly and not e.g. leave your AJAX request implementation hanging.

Note that the fetch action cannot currently report progress.

fetchLimit

fetchLimit: undefined | number

Specifies the upper limit of items that should be fetched. This gets passed back to the fetch as the query, but will also affect the behavior of fetchMore.

name

name: undefined | string

Debug-friendly name that can be back-queried from the state instance.