Function filterAndSuggestItems

filterAndSuggestItems<ItemType, IdType>(searchText?, dataItems?, excludedIds?, fieldsToSearch?, idKey?, stopWords?): SearchableItem<ItemType, IdType>[]
Filters and suggests objects from an array based on a description and specified fields.
Type Parameters
- ItemType
  Type of the items to be searched.
- IdType extends string | number = string
  Type of the identifier for each item (string or number).
Parameters
- searchText: string = ""
  The text to search within items.
- dataItems: SearchableItem<ItemType, IdType>[] = []
  The array of objects to search through.
- excludedIds: IdType | IdType[] = []
  An array of IDs or a single ID to exclude from search results.
- fieldsToSearch: string[] = ...
  The keys within each item to search against. Defaults to ["name"].
- idKey: string = "_id"
  The key representing the unique identifier in each item. Defaults to _id.
- stopWords: string[] = defaultStopWords
  A list of words to exclude from the search. Defaults to defaultStopWords.
Returns SearchableItem<ItemType, IdType>[]
A filtered array of objects matching the search criteria.
Example
```
// Basic usage with custom data shape
interface Product {
  id: string;
  name: string;
  description: string;
}

const products: Product[] = [
  { id: "1", name: "Apple", description: "A fresh apple" },
  { id: "2", name: "Banana", description: "Yellow banana" },
];

const results = filterAndSuggestItems<Product, string>(
  "apple",
  products,
  [], // No excluded IDs
  ["name", "description"], // Fields to search within
  "id" // ID key
);
console.log(results); // Logs items containing "apple"
```
- Defined in filterAndSuggestItems.ts:177

Generated using TypeDoc