Interface FilterSuggestionsGenerator`Alpha`

The FilterSuggestionsGenerator controller is responsible for generating filter suggestions controllers for a given commerce engine.

This controller relies on a Commerce API functionality that is not yet generally available. If you wish to use this feature in an implementation, please contact your Coveo representative.

interface FilterSuggestionsGenerator {
    filterSuggestions: GeneratedFilterSuggestionsControllers;
    state: FieldSuggestionsFacet[];
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- FilterSuggestionsGenerator

Index

Methods

Properties

filterSuggestions state

Methods

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

`Alpha`filterSuggestions

filterSuggestions: GeneratedFilterSuggestionsControllers

The filter suggestions controllers created by the filter suggestions generator.

`Alpha`state

state: FieldSuggestionsFacet[]

The state of the filter suggestions generator.

Interface FilterSuggestionsGenerator`Alpha`

Hierarchy (View Summary)

Index

Methods

Properties

Methods

Parameters

Returns Unsubscribe

Properties

`Alpha`filterSuggestions

`Alpha`state

Settings

On This Page

Interface FilterSuggestionsGeneratorAlpha

Hierarchy (View Summary)

Index

Methods

Properties

Methods

subscribe

Parameters

Returns Unsubscribe

Properties

AlphafilterSuggestions

Alphastate

Settings

On This Page

Interface FilterSuggestionsGenerator`Alpha`

`Alpha`filterSuggestions

`Alpha`state