Interface QuerySummaryState

A scoped and simplified part of the headless state that is relevant to the QuerySummary controller.

interface QuerySummaryState {
    durationInMilliseconds: number;
    durationInSeconds: number;
    firstResult: number;
    firstSearchExecuted: boolean;
    hasDuration: boolean;
    hasError: boolean;
    hasQuery: boolean;
    hasResults: boolean;
    isLoading: boolean;
    lastResult: number;
    query: string;
    total: number;
}

Hierarchy (View Summary)

Properties

durationInMilliseconds durationInSeconds firstResult firstSearchExecuted hasDuration hasError hasQuery hasResults isLoading lastResult query total

Properties

durationInMilliseconds

durationInMilliseconds: number

The duration, in milliseconds, that the last query took to execute.

durationInSeconds

durationInSeconds: number

The duration, in seconds, that the last query took to execute.

firstResult

firstResult: number

The 1-based index of the first search result returned for the current page.

firstSearchExecuted

firstSearchExecuted: boolean

Determines if a first search has been executed.

hasDuration

hasDuration: boolean

Determines if a query execution time is available.

hasError

hasError: boolean

true if there is an error for the last executed query and false otherwise.

hasQuery

hasQuery: boolean

Determines if non-empty query has been executed.

hasResults

hasResults: boolean

Determines if there are results available for the last executed query.

isLoading

isLoading: boolean

Determines if a search is in progress.

lastResult

lastResult: number

The 1-based index of the last search result returned for the current page.

query

query: string

The query that was last executed (the content of the searchbox).

total

total: number

The total count of results available.

Settings

Member Visibility

On This Page

Properties