Skip to content

Commit b3c8aa2

Browse files
committed
fix: review update
1 parent dd11daf commit b3c8aa2

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

src/patternFly.search.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,8 @@ interface SearchPatternFlyOptions {
112112
* - Has `prefix`, `suffix` filtering for any non-"version" field.
113113
*
114114
* @note Filter formats are generally assumed to be string values. If expanding to other types, ensure
115-
* proper handling of non-string values.
115+
* proper handling of non-string values. Future updates should align with the string coercion used
116+
* in other code base searches.
116117
*
117118
* @param {FilterPatternFlyFilters} filters - Available filters for PatternFly data.
118119
* @param [mcpResources] - An optional map of available PatternFly documentation entries to search.
@@ -208,7 +209,7 @@ filterPatternFly.memo = memo(filterPatternFly, DEFAULT_OPTIONS.resourceMemoOptio
208209
* consider moving the await outside the loop to improve performance, possibly a
209210
* second iteration.
210211
*
211-
* @param searchQuery - Search query string
212+
* @param searchQuery - Search query. Values are coerced to string for fuzzy search.
212213
* @param {FilterPatternFlyFilters} filters - Available filters for PatternFly data.
213214
* @param [settings] - Optional settings object
214215
* @param [settings.mcpResources] - Optional function object of multifaceted documentation entries to search.
@@ -228,7 +229,7 @@ filterPatternFly.memo = memo(filterPatternFly, DEFAULT_OPTIONS.resourceMemoOptio
228229
* - `totalPotentialMatches`: Total number of available PatternFly keywords to match on, what was possible before narrowing.
229230
* - `totalResults`: Total number of actual resources that meet all criteria.
230231
*/
231-
const searchPatternFly = async (searchQuery: string | number, filters?: FilterPatternFlyFilters | undefined, {
232+
const searchPatternFly = async (searchQuery: unknown, filters?: FilterPatternFlyFilters | undefined, {
232233
mcpResources,
233234
allowWildCardAll = false,
234235
maxDistance = 3,

0 commit comments

Comments
 (0)