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

A library for powering UI components for Yext Search integrations

import { State } from './state';

/**
 * Represents a listener for a specific value of type T in the state.
 *
 * @public
 */
export default interface StateListener<T> {
  /**
   * Accesses a value of type T in the state.
   *
   * @param state - The current state
   * @returns The value of type T from the state
   */
  valueAccessor(state: State): T,
  /**
   * The function to call when the state value updates.
   *
   * @param currentValue - The current state value
   */
  callback(currentValue: T)
}