Interface HistoryManager

The HistoryManager controller is in charge of allowing navigating back and forward in the search interface history.

Example: history-manager.fn.tsx

interface HistoryManager {
    state: HistoryManagerState;
    back(): Promise<void>;
    backOnNoResults(): Promise<void>;
    forward(): Promise<void>;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Methods

back backOnNoResults forward subscribe

Properties

state

Methods

back

  • back(): Promise<void>

  • Move backward in the interface history.

    Returns Promise<void>

    A promise that resolves when the previous state has been restored.

backOnNoResults

  • backOnNoResults(): Promise<void>

  • Move backward in the interface history when there are no results.

    Returns Promise<void>

    A promise that resolves when the previous state has been restored.

forward

  • forward(): Promise<void>

  • Move forward in the interface history.

    Returns Promise<void>

    A promise that resolves when the next state has been restored.

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.

Properties

state

state: HistoryManagerState

The state relevant to the HistoryManager controller.

Settings

Member Visibility

On This Page

Methods
Properties