@coveo/headless-react
    Preparing search index...

    Interface RelevanceInspector

    The RelevanceInspector controller is in charge of allowing displaying various debug information.

    Example: relevance-inspector.fn.tsx

    interface RelevanceInspector {
        state: RelevanceInspectorState;
        disable(): void;
        disableFetchAllFields(): void;
        enable(): void;
        enableFetchAllFields(): void;
        fetchFieldsDescription(): void;
        subscribe(listener: () => void): Unsubscribe;
    }

    Hierarchy (View Summary)

    Index

    Methods

    disable disableFetchAllFields enable enableFetchAllFields fetchFieldsDescription subscribe

    Properties

    state

    Methods

    • Disables debug mode.

      Returns void

    • Disable fetching all available fields from the index.

      Returns void

    • Enables debug mode.

      Returns void

    • Fetch all fields available from the index on each individual results.

      Returns void

    • Fetch the description of all fields available from the index.

      Returns void

    • Adds a callback that's invoked on state change.

      Parameters

      • listener: () => void

        A callback that's invoked on state change.

      Returns Unsubscribe

      A function to remove the listener.

    Properties

    state: RelevanceInspectorState

    The state of the RelevanceInspector controller.

    Settings

    Member Visibility

    On This Page

    Methods
    Properties