@microsoft/kiota
Version:
npm package exposing Kiota CLI functionality to TypeScript
18 lines (17 loc) • 898 B
TypeScript
import { KiotaManifestResult } from "..";
export interface ManifestOptions {
manifestPath: string;
clearCache?: boolean;
apiIdentifier?: string;
}
/**
* Retrieves the manifest details for a given API.
*
* @param {ManifestOptions} options - The options for retrieving the manifest details.
* @param {string} options.manifestPath - The path to the manifest file.
* @param {boolean} [options.clearCache] - Whether to clear the cache before retrieving the manifest details.
* @param {string} [options.apiIdentifier] - The identifier of the API.
* @returns {Promise<KiotaManifestResult | undefined>} A promise that resolves to the manifest details or undefined if not found.
* @throws {Error} Throws an error if the request fails.
*/
export declare function getManifestDetails({ manifestPath, clearCache, apiIdentifier }: ManifestOptions): Promise<KiotaManifestResult | undefined>;