@yext/search-core/src/models/searchservice/response/DisplayableFacet.ts

Typescript Networking Library for the Yext Search API

import { Facet, FacetOption } from '../request/Facet';

/**
 * A {@link Facet} which contains extra fields meant to be displayed to the end user.
 *
 * @public
 */
export interface DisplayableFacet extends Facet {
  /** An array of {@link DisplayableFacetOption} */
  options: DisplayableFacetOption[],
  /** The name of the facet which is meant to be displayed to the user. */
  displayName: string
}

/**
 * A {@link FacetOption} with extra data meant to be displayed to the end user.
 *
 * @public
 */
export interface DisplayableFacetOption extends FacetOption {
  /** The name of the facet option which is meant  to be displayed to the end user. */
  displayName: string,
  /** The number of results associated with this facet option. */
  count: number,
  /** Whether or not the filter is selected in the search results. */
  selected: boolean
}