Interface InsightInterface

The InsightInterface controller is responsible for retrieving the Insight interface configuration.

interface InsightInterface {
    state: InsightInterfaceState;
    fetch(): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- InsightInterface

Index

Methods

fetch subscribe

Properties

Methods

fetch

fetch(): void
Fetches the Insight interface configuration.

Returns void
- Defined in packages/headless/src/controllers/insight-interface/insight-interface.ts:30

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: InsightInterfaceState

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