Interface FieldSuggestionsGenerator

The FieldSuggestionsGenerator controller is responsible for generating field suggestions controllers for a given commerce engine.

interface FieldSuggestionsGenerator {
    fieldSuggestions: GeneratedFieldSuggestionsControllers;
    state: FieldSuggestionsFacet[];
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- FieldSuggestionsGenerator

Index

Methods

Properties

fieldSuggestions state

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

fieldSuggestions

fieldSuggestions: GeneratedFieldSuggestionsControllers

The facet controllers created by the facet generator.

state

state: FieldSuggestionsFacet[]

The state of the field suggestions generator.