Interface RecentResultsList

The RecentResultsList controller manages a user's recently clicked results.

Example: recent-results.fn.tsx

interface RecentResultsList {
    state: RecentResultsState;
    clear(): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- RecentResultsList

Index

Methods

clear subscribe

Properties

Methods

clear

clear(): void
Clears the recent results list.

Returns void
- Defined in packages/headless/src/controllers/recent-results-list/headless-recent-results-list.ts:81

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

The state of the RecentResultsList controller.