coveo-search-ui/src/rest/Facet/FacetResponse.ts

Coveo JavaScript Search Framework

import { FacetValueState } from './FacetValueState';
import { IRangeValue } from '../RangeValue';

/**
 * A [values]{@link IFacetRequest.values} item in a Search API [facet response]{@link IFacetRequest}.
 */
export interface IFacetResponseValue extends IRangeValue {
  /**
   * The facet value name.
   */
  value?: string;

  /**
   * The facet value state to display in the search interface.
   */
  state: FacetValueState;

  /**
   * The number of query result items matching the facet value.
   */
  numberOfResults: number;

  /**
   * Whether additional values are available for the facet.
   */
  moreValuesAvailable?: boolean;

  /**
   * The children of this hierarchical facet value.
   */
  children?: IFacetResponseValue[];

  /**
   * When the hierarchical value has no children, this property is `true`.
   */
  isLeafValue?: boolean;
}

/**
 * An item in the response of a Search API [facet request]{@link IFacetRequest}.
 */
export interface IFacetResponse {
  /**
   * The unique facet identifier in the search interface.
   */
  facetId: string;

  /**
   * The name of the field on which the facet is based.
   */
  field: string;

  /**
   * Whether additional values are available for the facet.
   */
  moreValuesAvailable: boolean;

  /**
   * The returned facet values.
   *
   * See [IFacetResponseValue]{@link IFacetResponseValue}
   */
  values: IFacetResponseValue[];
}