Interface SettingsSearchConfig

Configuration object for Fuse.js fuzzy search.

Defines search behavior including which fields to search, matching sensitivity, and what metadata to include in results.

Source

export interface SettingsSearchConfig {
  keys: Array<{
    name: string;
    weight: number;
  }>;
  threshold: number;
  includeScore: boolean;
  includeMatches: boolean;
  minMatchCharLength: number;
  ignoreLocation: boolean;
}
interface SettingsSearchConfig {
    keys: { name: string; weight: number }[];
    threshold: number;
    includeScore: boolean;
    includeMatches: boolean;
    minMatchCharLength: number;
    ignoreLocation: boolean;
}

Properties

keys threshold includeScore includeMatches minMatchCharLength ignoreLocation

Properties

keys

keys: { name: string; weight: number }[]

Fields to search with their relative importance weights (0.0 to 1.0).

threshold

threshold: number

Fuzzy match threshold (0.0 to 1.0, 0.4 recommended for balance).

includeScore

includeScore: boolean

Include relevance scores in results.

includeMatches

includeMatches: boolean

Include match indices in results for highlighting.

minMatchCharLength

minMatchCharLength: number

Minimum characters in query to start matching.

ignoreLocation

ignoreLocation: boolean

Ignore position of match in string when scoring.

Settings

Member Visibility

On This Page

Properties