Skip to content

Commit

Permalink
Update shapes
Browse files Browse the repository at this point in the history
  • Loading branch information
obany committed Jan 8, 2024
1 parent 18b6c73 commit fb00f69
Showing 1 changed file with 19 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,25 @@ export interface IntegrationModule<O = unknown> extends ModuleImplementation<O,
isSuggestion?: boolean;
}
): Promise<HomeSearchResponse>;
/**
* Get entries to show while the integration is searching.
* @param query The query to search for.
* @param lastResponse The last search response used for updating existing results.
* @param options Options for the search query.
* @param options.queryMinLength The minimum length before a query is actioned.
* @param options.queryAgainst The fields in the data to query against.
* @param options.isSuggestion Is the query from a suggestion.
* @returns The list of results and new filters.
*/
getSearchResultsProgress?(
query: string,
lastResponse: HomeSearchListenerResponse,
options: {
queryMinLength: number;
queryAgainst: string[];
isSuggestion?: boolean;
}
): Promise<HomeSearchResult[]>;
/**
* Get a list of the static help entries.
* @returns The list of help entries.
Expand Down

0 comments on commit fb00f69

Please sign in to comment.