vitepress-jsdoc/dist/commonjs/utilities/file-operations.d.ts

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

import { type ParseReturn } from '../interfaces.js';
/**
 * Deletes the specified documentation folder and any additional paths matching the provided patterns.
 *
 * @function
 * @async
 *
 * @param {string} docsFolder - The path to the documentation folder to be deleted.
 * @param {string[]} rmPattern - An array of glob patterns specifying additional paths to be deleted.
 *
 * @returns {Promise<string[]>} A promise that resolves with an array of paths that were deleted.
 *
 * @throws Will throw an error if not all paths were successfully deleted.
 *
 * @example
 *
 * const docsFolder = './docs';
 * const rmPattern = ['**\/*.tmp']; // remove backslash
 *
 * const deletedPaths = await deleteDocsFolder(docsFolder, rmPattern);
 */
export declare const deleteDocsFolder: (docsFolder: string, rmPattern: string[]) => Promise<string[]>;
export declare const createDocsFolder: (docsFolder: string) => void;
/**
 * Writes the parsed content to a file on disk.
 *
 * @function
 * @async
 *
 * @param {ParseReturn | undefined} parseData - The parsed data to be written to the file.
 * @param {string} dest - The destination path where the file should be written.
 *
 * @returns {Promise<object | null>} A promise that resolves with an object containing details of the saved file, or null if the operation fails.
 * The returned object includes the original parsed data and a type indicating the status of the operation (e.g., included, excluded, error).
 *
 * @throws Will throw an error if there's an issue creating directories or writing to the file system.
 *
 * @example
 *
 * const parseData = {
 *   content: '# My Documentation',
 *   file: {name: 'example', ext: '.md'},
 *   empty: false,
 *   excluded: false
 * };
 * const dest = './docs';
 *
 * const result = await writeContentToFile(parseData, dest);
 */
export declare const writeContentToFile: (parseData: ParseReturn | undefined, dest: string) => Promise<ParseReturn | undefined>;
//# sourceMappingURL=file-operations.d.ts.map