@yext/search-headless/src/models/state-manager.ts

A library for powering UI components for Yext Search integrations

import { Unsubscribe } from '@reduxjs/toolkit';
import { State } from './state';
import StateListener from './state-listener';

/**
 * Manages the information contained in the state for a SearchHeadless instance.
 *
 * @remarks
 * The {@link State} is immutable, and can only be updated by dispatched events.
 *
 * @public
 */
export default interface StateManager {
  /**
   * Returns the current state.
   */
  getState(): State,
  /**
   * Dispatches an event. This can update the {@link State}.
   *
   * @param type - The type of action to dispatch
   * @param payload - The payload of the action to dispatch
   */
  dispatchEvent(type: string, payload?: unknown): void,
  /**
   * Adds a listener for a specific state value of type T.
   *
   * @param listener - The state listener to add
   * @returns The function for removing the added listener
   */
  addListener<T>(listener: StateListener<T>): Unsubscribe
}