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)

Methods

subscribe synchronize

Properties

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.

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

    Returns void

Properties

state

state: SearchParameterManagerState

The state relevant to the SearchParameterManager controller.

Settings

Member Visibility

On This Page

Methods
Properties