@microsoft/kiota
Version:
npm package exposing Kiota CLI functionality to TypeScript
16 lines (15 loc) • 834 B
TypeScript
import { KiotaSearchResultItem } from "..";
export interface SearchConfiguration {
searchTerm: string;
clearCache: boolean;
}
/**
* Searches for a description based on the provided search term and cache settings.
*
* @param {SearchConfiguration} config - The search configuration object.
* @param {string} config.searchTerm - The term to search for.
* @param {boolean} config.clearCache - Whether to clear the cache before searching.
* @returns {Promise<Record<string, KiotaSearchResultItem> | undefined>} A promise that resolves to a record of search results or undefined if no results are found.
* @throws {Error} Throws an error if the search operation fails.
*/
export declare function searchDescription({ searchTerm, clearCache }: SearchConfiguration): Promise<Record<string, KiotaSearchResultItem> | undefined>;