Interface FacetManager

The FacetManager controller helps reorder facets to match the most recent search response.

interface FacetManager {
    state: FacetManagerState;
    sort<T>(facets: FacetManagerPayload<T>[]): FacetManagerPayload<T>[];
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- FacetManager

Index

Methods

Properties

Methods

sort

sort<T>(facets: FacetManagerPayload<T>[]): FacetManagerPayload<T>[]
Sorts the facets to match the order in the most recent search response.
Type Parameters
- T
Parameters
- facets: FacetManagerPayload<T>[]
  An array of facet payloads to sort.
Returns FacetManagerPayload<T>[]
A sorted array.
- Defined in packages/headless/src/controllers/core/facet-manager/headless-core-facet-manager.ts:38

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

The state of the CoreFacetManager controller.