Interface ParameterManager<T>

The ParameterManager sub-controller allows restoring parameters that affect the results (e.g., from the URL).

interface ParameterManager<T extends Parameters> {
    state: ParameterManagerState<T>;
    subscribe(listener: () => void): Unsubscribe;
    synchronize(parameters: T): void;
}

Type Parameters

T extends Parameters

Hierarchy (View Summary)

Controller
- ParameterManager

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: T): void
Updates the parameters in the state with the specified parameters and fetches results. Unspecified keys are reset to their initial values.
Parameters
- parameters: T
  The parameters to synchronize.
Returns void
- Defined in packages/headless/dist/definitions/controllers/commerce/core/parameter-manager/headless-core-parameter-manager.d.ts:57

Properties

state

state: ParameterManagerState<T>

The state relevant to the ParameterManager sub-controller.