export interface BaseOutputOptions { /** * Path of the file to write the table of contents to */ filePath: string; } export interface WriteModeOptions { /** * Write mode for the output */ writeMode: 'overwrite' | 'append' | 'replace-placeholder'; } export interface OutputOptionsWithoutPlaceholder extends BaseOutputOptions, WriteModeOptions { writeMode: 'overwrite' | 'append'; } export interface Placeholder { /** * Start of the placeholder text */ start: string; /** * End of the placeholder text */ end: string; } export interface OutputOptionsWithPlaceholder extends BaseOutputOptions, WriteModeOptions { writeMode: 'replace-placeholder'; placeholder: Placeholder; } export type OutputOptions = OutputOptionsWithoutPlaceholder | OutputOptionsWithPlaceholder; export interface GenerateHelpOfCliAppsInMarkdownFormatOptions { /** * Paths of CLI utility files */ cliAppFilePaths: Array; /** * Header level of the root header. Example: If you want generated headers to have 4 hashes, then specify 3 here * * @defaultValue * 2 */ rootHeaderLevel?: number; /** * Output options */ output?: OutputOptions; } /** * Generates help messages of CLI applications in markdown format */ export declare function generateHelpOfCliAppsInMarkdownFormat(options: GenerateHelpOfCliAppsInMarkdownFormatOptions): Promise;