Brief Description

Currently searchItems type, and search() function return type is SearchItem.
However, it could be great to add support to a generic type, to make the function return a custom type (extending from SearchItem).

If that's okay, I can make a PR myself.

Environment

• @smakss/search version: 2.0.1
• node.js version: v21.7.1
• npm version: v10.5.0

Code Snippet

Here's an example of what it could be.

interface MyCustomType extends SearchItem {}

const items: MyCustomType[] = [{}, {}, {}] // …
const result: MyCustomType[] = search<MyCustomType>({ searchItems: items, searchText: '…' });

Brief Description

Currently the options parameter of the search function is of type Partial<SearchOptions>.
All properties have a default value.
As searchItems and searchText are mandatory for the search, they shouldn't be optional.

The options type should be a type with keys, include, exact optional, and searchItems, searchText required.

If that's okay, I can make a PR myself.

Environment

• @smakss/search version: 2.0.1
• node.js version: v21.7.1
• npm version: v10.5.0