vitepress-jsdoc/dist/commonjs/utilities/output.d.ts

A bridge between Vitepress and JSDoc-style commented codebases for hassle-free documentation.

import { type ParseReturn, type FolderData } from '../interfaces.js';
/**
 * Asynchronously prints the paths of files from the provided `FolderData` to the console.
 * For each file:
 * - If it's a directory, it's skipped.
 * - If it's a file, its path is printed to the console.
 *
 * @function
 * @async
 * @param {FolderData} lsFolder - The data structure containing paths and other folder-related information.
 * @returns {Promise<void>} A promise that resolves once all file paths have been printed.
 * @example
 *
 * const folderData = {
 *   paths: [...],
 *   tree: [...],
 *   excluded: [...]
 * };
 * await printFiles(folderData);
 */
export declare const printFiles: (lsFolder: FolderData) => Promise<void>;
/**
 * Prints statistics about the processed files to the console.
 * - First, it prints all excluded files with the label 'EXCLUDE'.
 * - Then, for each entry in the `result`:
 *   - If there's no file associated with the entry, it's skipped.
 *   - Otherwise, it logs the type of the entry and the source to destination mapping.
 *
 * @function
 * @param {FolderData} lsFolder - The data structure containing paths and other folder-related information.
 * @param {ParseReturn[]} result - An array of results from the parsing process.
 * @example
 *
 * const folderData = {
 *   paths: [...],
 *   tree: [...],
 *   excluded: [...]
 * };
 * const results = [...];
 * printStats(folderData, results);
 */
export declare const printStats: (lsFolder: FolderData, result: ParseReturn[]) => void;
//# sourceMappingURL=output.d.ts.map