Interface FilterSpotlightItemsOptions<TItem>

Options accepted by filterSpotlightItems.

interface FilterSpotlightItemsOptions<
    TItem extends SpotlightItem = SpotlightItem,
> {
    items: readonly TItem[];
    limit?: number;
    query?: string;
}

Properties

items: readonly TItem[]

Ordered source items. Caller-owned data is never mutated.

limit?: number

Maximum returned results.

query?: string

Search query. Whitespace is trimmed and matching is case-insensitive.