Function useObservableQuery

useObservableQuery<
    TDataType,
    TQuery extends IObservableQueryFor<TDataType>,
    TArguments = object,
>(
    query: Constructor<TQuery>,
    args?: TArguments,
    sorting?: any,
    isEnabled?: boolean,
): [QueryResultWithState<TDataType>, SetSorting]
React hook for working with IObservableQueryFor within the state management of React.
Type Parameters
- TDataType
  Type of model the query is for.
- TQuery extends IObservableQueryFor<TDataType>
  Type of observable query to use.
- TArguments = object
  Optional: Arguments for the query, if any
Parameters
- query: Constructor<TQuery>
  Query type constructor.
- Optionalargs: TArguments
  Optional: Arguments for the query, if any
- Optionalsorting: any
  Optional: Sorting for the query, if any
- OptionalisEnabled: boolean
  Optional: Whether the query should subscribe. Defaults to true. When false, the hook is a no-op and returns an empty result.
Returns [QueryResultWithState<TDataType>, SetSorting]
Tuple of QueryResultWithState and a PerformQuery delegate.
- Defined in queries/useObservableQuery.ts:312