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

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

import { type DirectoryFile } from '../interfaces.js';
/**
 * @file This module provides functionality to read the content of a file and parse its Vitepress header.
 */
/**
 * Reads the content of a file and parses its Vitepress header.
 *
 * @function
 * @async
 *
 * @param {DirectoryFile} file - The file object representing the file to be read.
 *
 * @returns {Promise<string>} A promise that resolves with the parsed content of the file.
 *
 * @throws Will throw an error if there's an issue reading the file or parsing its content.
 *
 * @example
 *
 * const file = {name: 'example', ext: '.md', folder: '/src/docs'};
 * const content = await readFileContent(file);
 */
export declare const readFileContent: (file: DirectoryFile) => Promise<string>;
//# sourceMappingURL=file-reader.d.ts.map