Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UseQueryResult<S, C>

Type parameters

  • S: QuerySelect

  • C: QueryCalculations<S>

Hierarchy

  • ExpandedQueryResult<S, C>
    • UseQueryResult

Index

Properties

records: ExpandedQueryRecord<S, C>[]

The set of records returned, each having named properties corresponding to the plain and aggregated columns selected in the query.

The state of the query operation:

  • init - no result has been downloaded yet
  • ready - result has been downloaded
  • refresh - a new result is being downloaded
  • error - most recent query attempt failed
totals?: AggregateValuesOnly<S> & CalculationValues<C>

Optional extra record, only available if {@link QueryJson.totals} was specified as true in the query, containing the aggregation totals.

Generated using TypeDoc