@coveo/headless
    Preparing search index...

    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)

    Index

    Properties

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

    Properties

    durationInMilliseconds: number

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

    durationInSeconds: number

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

    firstResult: number

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

    firstSearchExecuted: boolean

    Determines if a first search has been executed.

    hasDuration: boolean

    Determines if a query execution time is available.

    hasError: boolean

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

    hasQuery: boolean

    Determines if non-empty query has been executed.

    hasResults: boolean

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

    isLoading: boolean

    Determines if a search is in progress.

    lastResult: number

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

    query: string

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

    total: number

    The total count of results available.

    Settings

    Member Visibility

    On This Page

    Properties