Interface SearchEngine

The SSR search engine.

interface SearchEngine {
    dispatch: EngineDispatch<
        {
            debug: boolean;
            pipeline: string;
            search: SearchState;
            searchHub: string;
        } & Partial<SearchAppState> & {
            configuration: ConfigurationState;
            version: string;
        } & Partial<SearchParametersState>,
        SearchThunkExtraArguments,
    >;
    logger: Logger;
    navigatorContext: NavigatorContext;
    relay: Relay;
    state: {
        debug: boolean;
        pipeline: string;
        search: SearchState;
        searchHub: string;
    } & Partial<SearchAppState> & {
        configuration: ConfigurationState;
        version: string;
    } & Partial<SearchParametersState>;
    store: EnhancedStore<
        any,
        UnknownAction,
        Tuple<[StoreEnhancer<{ dispatch: {} }, {}>, StoreEnhancer<{}, {}>]>,
    >;
    addReducers(
        reducers: { [key: string]: Reducer<any, UnknownAction, any> },
    ): void;
    disableAnalytics(): void;
    enableAnalytics(): void;
    executeFirstSearch(analyticsEvent?: LegacySearchAction): void;
    executeFirstSearchAfterStandaloneSearchBoxRedirect(
        analytics: StandaloneSearchBoxAnalytics,
    ): void;
    subscribe(listener: () => void): Unsubscribe;
    waitForSearchCompletedAction(): Promise<SearchCompletedAction>;
}

Hierarchy

  • SearchEngine
    • SearchEngine

Methods

addReducers disableAnalytics enableAnalytics executeFirstSearch executeFirstSearchAfterStandaloneSearchBoxRedirect subscribe waitForSearchCompletedAction

Properties

dispatch logger navigatorContext relay state store

Methods

addReducers

  • addReducers(reducers: { [key: string]: Reducer<any, UnknownAction, any> }): void

  • Adds the specified reducers to the store.

    Parameters

    • reducers: { [key: string]: Reducer<any, UnknownAction, any> }

      An object containing the reducers to attach to the engine.

    Returns void

disableAnalytics

  • disableAnalytics(): void

  • Disable analytics tracking

    Returns void

enableAnalytics

  • enableAnalytics(): void

  • Enable analytics tracking

    Returns void

executeFirstSearch

  • executeFirstSearch(analyticsEvent?: LegacySearchAction): void

  • Executes the first search.

    Parameters

    • OptionalanalyticsEvent: LegacySearchAction

      The analytics event to log in association with the first search. If unspecified, logInterfaceLoad will be used.

    Returns void

executeFirstSearchAfterStandaloneSearchBoxRedirect

  • executeFirstSearchAfterStandaloneSearchBoxRedirect(
        analytics: StandaloneSearchBoxAnalytics,
    ): void

  • Executes the first search, and logs the analytics event that triggered a redirection from a standalone search box.

    Parameters

    Returns void

subscribe

  • subscribe(listener: () => void): Unsubscribe

  • Adds a change listener. It will be called any time an action is dispatched, and some part of the state tree may potentially have changed. You may then access the new state.

    Parameters

    • listener: () => void

      A callback to be invoked on every dispatch.

    Returns Unsubscribe

    A function to remove this change listener.

waitForSearchCompletedAction

  • waitForSearchCompletedAction(): Promise<SearchCompletedAction>

  • Waits for the search to be completed and returns a promise that resolves to a SearchCompletedAction.

    Returns Promise<SearchCompletedAction>

Properties

dispatch

dispatch: EngineDispatch<
    {
        debug: boolean;
        pipeline: string;
        search: SearchState;
        searchHub: string;
    } & Partial<SearchAppState> & {
        configuration: ConfigurationState;
        version: string;
    } & Partial<SearchParametersState>,
    SearchThunkExtraArguments,
>

Dispatches an action directly. This is the only way to trigger a state change. Each headless controller dispatches its own actions.

Param: action

An action supported by the headless engine.

Returns

For convenience, the action object that was just dispatched.

logger

logger: Logger

The logger instance used by headless.

navigatorContext

navigatorContext: NavigatorContext

The navigator context (referer, location, UserAgent)

relay

relay: Relay

The Relay instance used by Headless.

state

state: {
    debug: boolean;
    pipeline: string;
    search: SearchState;
    searchHub: string;
} & Partial<SearchAppState> & {
    configuration: ConfigurationState;
    version: string;
} & Partial<SearchParametersState>

The complete headless state tree.

store

store: EnhancedStore<
    any,
    UnknownAction,
    Tuple<[StoreEnhancer<{ dispatch: {} }, {}>, StoreEnhancer<{}, {}>]>,
>

The redux store.

Settings

Member Visibility

On This Page

Methods
Properties