Customization

Fuzzy-List-Optionen

Um das Suchverhalten anzupassen, geben Sie ein Optionsobjekt mit den folgenden Parametern an:

index.ts

const fuzzySearch = fuzzy(list, {
  key: "name", // Eigenschaft, in der gesucht werden soll
  getKey: (item) => [item.name, item.author.fullname], // Mehrere Eigenschaften durchsuchen
  debug: true, // Debugging aktivieren
  limit: 10, // Maximale Anzahl der Ergebnisse
  maxScore: 2.5, // Maximaler Score-Schwellenwert für Ergebnisse
  mapResult: (item) => item, // Ergebnisobjekt transformieren
});

`key` und `getKey`

Wenn der Datensatz aus Objekten besteht, verwenden Sie key oder getKey, um die zu durchsuchenden Eigenschaften anzugeben.

index.ts

type Fuzzy<T> = (query: string) => {
  results: Result<T>[];
  length: number;
  time: number;
  normalizedQuery: string;
  hasExactMatch: boolean;
  bestMatch: Result<T> | null;
  hasResults: boolean;
};
 
function fuzzy<T>(collection: T[], options?: FuzzyOptions<T>): Fuzzy<T>;
 
const list = [
  { name: "volvo", year: 2020 },
  { name: "seat", year: 2019 },
  { name: "mercedes", year: 2021 },
  { name: "audi", year: 2022 },
  { name: "bmw", year: 2023 },
];
 
const fuzzySearch = fuzzy(list, {
  key: "name"
});
 
const fuzzedList = fuzzySearch("volv");
console.log(fuzzedList);

Ebenso ermöglicht getKey die Suche über mehrere oder verschachtelte Eigenschaften.

index.ts

const list = [
  { name: "volvo", owner: { fullname: "John Doe" } },
  { name: "seat", owner: { fullname: "Jane Doe" } },
  { name: "mercedes", owner: { fullname: "John Smith" } },
];
 
const fuzzySearch = fuzzy(list, {
  getKey: (item) => [item.owner.fullname, item.name],
});

`limit`-Option

Begrenzt die Anzahl der zurückgegebenen Suchergebnisse. Nützlich für die Optimierung des UI-Renderings.

index.ts

const fuzzySearch = fuzzy(["volvo", "seat", "mercedes", "audi", "bmw"], {
  limit: 5,
});

Das Resultset enthält maximal 5 Einträge.

`maxScore`-Option

Filtert Ergebnisse nach Score, der die Entfernung von einer exakten Übereinstimmung darstellt.

index.ts

const fuzzySearch = fuzzy(["volvo", "seat", "mercedes", "audi", "bmw"], {
  maxScore: 2, // Ergebnisse mit einem Score über 2 ausschließen
});

Sortierverhalten

Wenn sowohl limit als auch maxScore verwendet werden, werden die Ergebnisse zuerst nach Score gefiltert und dann auf das limit gekürzt.

`debug`-Option

Aktiviert die Protokollierung von Suchausführungsdetails in der Konsole.

index.ts

const fuzzySearch = fuzzy(["volvo", "seat", "mercedes"], {
  debug: true,
});

`mapResult`-Option

Transformiert Ergebnisobjekte, bevor sie zurückgegeben werden.

index.ts

const fuzzySearch = fuzzy(["volvo", "seat", "mercedes", "audi", "bmw"], {
  mapResult: (item) => item.toUpperCase(),
});
 
const result = fuzzySearch("volvo");
console.log(result.results[0].item); // "VOLVO"

Die Bibliothek verwendet zwei Generics: eines für den Eingabetyp (Listeneinträge) und eines für den Ausgabetyp (Ergebniseinträge). Wenn mapResult verwendet wird, passt sich der Ausgabetyp entsprechend an.

index.ts

function fuzzy<T, U = T>(collection: T[], options?: FuzzyOptions<T, U>): Fuzzy<U>;

Anpassung

Fuzzy-List-Optionen

`key` und `getKey`

`limit`-Option

`maxScore`-Option

Sortierverhalten

`debug`-Option

`mapResult`-Option

TypeScript-Generics

On this page