Interface UseQueryReturn<T>

The Ditto instance used by this hook. null until the provider has loaded an instance for the requested persistence directory.

The most recent error that occurred while setting up the query.

Use the onError callback parameter to handle errors as they occur.

true during the initial setup of the query. Resetting the query with reset will not set this back to true to avoid flickering when used in UIs.

The items returned by the query.

An empty array while isLoading is true.

Reset the state of this hook.

This will cancel and reconfigure the StoreObserver and SyncSubscription, and return error and items to their initial null state.

This does not set isLoading to true during the reset process. However, the promise returned by this function will resolve once the reset is complete.

The underlying Ditto StoreObserver. undefined until the query has been configured.

The underlying Ditto SyncSubscription. This is undefined when the localOnly parameter is set to true.