@coveo/headless
    Preparing search index...

    Interface DocumentSuggestionListState

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

    interface DocumentSuggestionListState {
        documents: DocumentSuggestionResponse[];
        error: null | CaseAssistAPIErrorStatusResponse;
        loading: boolean;
    }
    Index

    Properties

    The retrieved document suggestions.

    error: null | CaseAssistAPIErrorStatusResponse

    The Case Assist API error response.

    loading: boolean

    Whether document suggestions are being retrieved.