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)

Controller
- RelevanceInspector

Index

Methods

disable disableFetchAllFields enable enableFetchAllFields fetchFieldsDescription subscribe

Properties

Methods

disable

disable(): void
Disables debug mode.

Returns void
- Defined in packages/headless/src/controllers/relevance-inspector/headless-relevance-inspector.ts:100

disableFetchAllFields

disableFetchAllFields(): void
Disable fetching all available fields from the index.

Returns void
- Defined in packages/headless/src/controllers/relevance-inspector/headless-relevance-inspector.ts:91

enable

enable(): void
Enables debug mode.

Returns void
- Defined in packages/headless/src/controllers/relevance-inspector/headless-relevance-inspector.ts:95

enableFetchAllFields

enableFetchAllFields(): void
Fetch all fields available from the index on each individual results.

Returns void
- Defined in packages/headless/src/controllers/relevance-inspector/headless-relevance-inspector.ts:87

fetchFieldsDescription

fetchFieldsDescription(): void
Fetch the description of all fields available from the index.

Returns void
- Defined in packages/headless/src/controllers/relevance-inspector/headless-relevance-inspector.ts:83

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.
Inherited from Controller.subscribe
- Defined in packages/headless/src/controllers/controller/headless-controller.ts:11

Properties

state

state: RelevanceInspectorState

The state of the RelevanceInspector controller.