Interface SupplierFactoryOptions

export interface SupplierFactoryOptions {
  /** Fetch controller (can be used to terminate the query). */
  controller: AbortController;
  /** Maximum number of results per supplier. Defaults to `defaultResultsLimit`. */
  limit?: number;
  /** Suppliers to query; empty (the default) queries all. */
  suppliers?: Array<SupplierClassName>;
  /** Whether to read from / write to the supplier caches. Defaults to true. */
  caching?: boolean;
  /** Fuzz-scorer name (from `FUZZ_SCORERS`) overriding each supplier's default. */
  fuzzScorerOverride?: string;
  /** When true, suppliers returning zero results skip writing a cache entry. Defaults to false. */
  doNotCacheEmptyResults?: boolean;
  /** Max age (minutes) of a query cache entry before eviction on read; 0 disables. Defaults to 0. */
  cacheTtlMinutes?: number;
  /** HTTP statuses that prevent a product-detail fetch from being cached. Defaults to [429]. */
  noCacheStatusCodes?: number[];
  /** Override (ms) for each supplier's search-time budget. Omit to keep per-supplier defaults. */
  maxAllowableSearchTimeSec?: number;
  /** When true, suppliers skip fuzzball scoring and show raw/boolean-only results. Defaults to false. */
  fuzzyFilteringDisabled?: boolean;
  /** User's ISO 3166-1 alpha-2 location; enables the shipping/restriction filters below. */
  location?: string;
  /** When true (with a `location`), drop suppliers that don't ship to the user. Defaults to false. */
  excludeNonShippingSuppliers?: boolean;
  /** When true, hide products the user can't buy (region/buyer restrictions). Defaults to false. */
  hideRestrictedProducts?: boolean;
  /** Supplier class names to exclude from the search entirely, regardless of `suppliers`. Defaults to []. */
  disabledSuppliers?: Array<SupplierClassName>;
}
Copy