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)

Methods

disable disableFetchAllFields enable enableFetchAllFields fetchFieldsDescription subscribe

Properties

state

Methods

disable

  • disable(): void

    Disables debug mode.

    Returns void

disableFetchAllFields

  • disableFetchAllFields(): void

    Disable fetching all available fields from the index.

    Returns void

enable

  • enable(): void

    Enables debug mode.

    Returns void

enableFetchAllFields

  • enableFetchAllFields(): void

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

    Returns void

fetchFieldsDescription

  • fetchFieldsDescription(): void

    Fetch the description of all fields available from the index.

    Returns void

subscribe

  • subscribe(listener: () => void): Unsubscribe

    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

state: RelevanceInspectorState

The state of the RelevanceInspector controller.

Settings

Member Visibility

On This Page

Methods
Properties