Interface SearchParameterManager

The SearchParameterManager controller allows restoring parameters that affect the results from e.g. a url.

interface SearchParameterManager {
    state: SearchParameterManagerState;
    subscribe(listener: () => void): Unsubscribe;
    synchronize(parameters: SearchParameters): void;
}

Hierarchy (View Summary)

Controller
- SearchParameterManager

Index

Methods

subscribe synchronize

Properties

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

synchronize

synchronize(parameters: SearchParameters): void
Updates the search parameters in state with the passed parameters and executes a search. Unspecified keys are reset to their initial values.
Parameters
- parameters: SearchParameters
  The search parameters to synchronize.
Returns void
- Defined in packages/headless/dist/definitions/controllers/core/search-parameter-manager/headless-core-search-parameter-manager.d.ts:28

Properties

state

state: SearchParameterManagerState

The state relevant to the SearchParameterManager controller.