Interface Summary<State>

The Summary sub-controller manages a summary of the current search results.

interface Summary<State extends SummaryState = SummaryState> {
state: State;
subscribe(listener: () => void): Unsubscribe;
}

Type Parameters

State extends SummaryState = SummaryState

Hierarchy (View Summary)

Controller
- Summary

Index

Methods

Properties

Methods

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/dist/definitions/controllers/controller/headless-controller.d.ts:10

Properties

state

state: State

A scoped and simplified part of the headless state that is relevant to the SearchSummary sub-controller.