Interface UserSettings

Application configuration settings that control various features and behaviors. Used to store user preferences and feature flags.

Example

const userSettings: UserSettings = {
  showHelp: true,
  caching: true,
  currency: "USD",
  location: "US",
  suppliers: ["supplier1", "supplier2"],
  theme: "light"
};

interface UserSettings {
    showHelp?: boolean;
    caching?: boolean;
    doNotCacheEmptyResults?: boolean;
    cacheTtlMinutes?: number;
    currencyRate?: number;
    currency?: string;
    location?: string;
    fontSize?: "medium" | "small" | "large";
    suppliers?: string[];
    theme?: "light" | "dark";
    showAllColumns?: boolean;
    hideColumns?: string[];
    showColumnFilters?: boolean;
    columnFilterConfig?: Record<string, ColumnMeta>;
    supplierResultLimit?: number;
    priceMin?: number;
    priceMax?: number;
    fuzzScorerOverride?: string;
}

Index

Properties

showHelp? caching? doNotCacheEmptyResults? cacheTtlMinutes? currencyRate? currency? location? fontSize? suppliers? theme? showAllColumns? hideColumns? showColumnFilters? columnFilterConfig? supplierResultLimit? priceMin? priceMax? fuzzScorerOverride?

Properties

`Optional`showHelp

showHelp?: boolean

Controls visibility of help tooltips throughout the application. Defaults to false.

`Optional`caching

caching?: boolean

Enables or disables data caching functionality. Defaults to true.

`Optional`doNotCacheEmptyResults

doNotCacheEmptyResults?: boolean

When true, suppliers that return zero results for a query will not write a cache entry for that query. Lets a previously-out-of-stock supplier surface fresh results on the next search instead of returning the cached empty list. Defaults to false.

`Optional`cacheTtlMinutes

cacheTtlMinutes?: number

Maximum age of a query cache entry, in minutes. On read, entries older than this are evicted and treated as a cache miss, forcing a fresh fetch. Set to 0 (the default) to disable TTL expiration entirely — entries then live until LRU eviction or version-mismatch eviction.

Example

`Optional`currencyRate

currencyRate?: number

Currency rate for the user's currency

Example

1.0

`Optional`currency

currency?: string

Selected currency code for price display

Example

"USD"

`Optional`location

location?: string

User's geographical location for shipping calculations

Example

"US"

`Optional`fontSize

fontSize?: "medium" | "small" | "large"

UI font size scale. Controls the root html font-size so every rem-based style (MUI defaults and styled components) scales proportionally.

Example

"medium"

`Optional`suppliers

suppliers?: string[]

List of supplier IDs that are enabled for searching

Example

["supplier1", "supplier2"]

`Optional`theme

theme?: "light" | "dark"

Selected UI theme identifier

Example

"light"

`Optional`showAllColumns

showAllColumns?: boolean

Controls visibility of all available table columns. Defaults to true.

`Optional`hideColumns

hideColumns?: string[]

List of column identifiers that should be hidden from view

Example

["price", "quantity"]

`Optional`showColumnFilters

showColumnFilters?: boolean

Controls visibility of column filter UI elements. Defaults to false.

`Optional`columnFilterConfig

columnFilterConfig?: Record<string, ColumnMeta>

Configuration object for individual column filter settings.

Example

{
  price: {
    filterVariant: "range",
    rangeValues: [0, 1000]
  }
}

`Optional`supplierResultLimit

supplierResultLimit?: number

Number of results to display per supplier

Example

`Optional`priceMin

priceMin?: number

Minimum price (in the user's selected currency) to include in results. Applied by useSearch.passesSearchFilters after suppliers return. Undefined disables the lower bound.

Example

`Optional`priceMax

priceMax?: number

Maximum price (in the user's selected currency) to include in results. Applied by useSearch.passesSearchFilters after suppliers return. Undefined disables the upper bound.

Example

`Optional`fuzzScorerOverride

fuzzScorerOverride?: string

Optional global override for the fuzz-match scorer used by each supplier. When set, fuzzyFilter uses this scorer instead of each supplier class's default fuzzScorer. Value is the exported function name from fuzzball (e.g. "ratio", "token_set_ratio", "WRatio").

Surfaced via the "Advanced" drawer accordion — hidden unless showAdvancedSettings is true in config.json.

Example

"token_set_ratio"

Interface UserSettings

Example

Index

Properties

Properties

OptionalshowHelp

Optionalcaching

OptionaldoNotCacheEmptyResults

OptionalcacheTtlMinutes

Example

OptionalcurrencyRate

Example

Optionalcurrency

Example

Optionallocation

Example

OptionalfontSize

Example

Optionalsuppliers

Example

Optionaltheme

Example

OptionalshowAllColumns

OptionalhideColumns

Example

OptionalshowColumnFilters

OptionalcolumnFilterConfig

Example

OptionalsupplierResultLimit

Example

OptionalpriceMin

Example

OptionalpriceMax

Example

OptionalfuzzScorerOverride

Example

Settings

On This Page

`Optional`showHelp

`Optional`caching

`Optional`doNotCacheEmptyResults

`Optional`cacheTtlMinutes

`Optional`currencyRate

`Optional`currency

`Optional`location

`Optional`fontSize

`Optional`suppliers

`Optional`theme

`Optional`showAllColumns

`Optional`hideColumns

`Optional`showColumnFilters

`Optional`columnFilterConfig

`Optional`supplierResultLimit

`Optional`priceMin

`Optional`priceMax

`Optional`fuzzScorerOverride